From: Jan Safranek <jsafrane@redhat.com>
Date: Mon, 29 Mar 2010 10:07:00 +0000 (+0200)
Subject: Add documentation main page
X-Git-Tag: v0.36~13^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=09957c91585eb01c968f771a8dbcf8a21963d740;p=thirdparty%2Flibcgroup.git

Add documentation main page

Add very simple main page to include/libcgroup.h. It contains just very
basic info and links to the other modules. Feel free to elaborate more on
this, it could contain lot more:
 - how to complie with libcgroup (=pkgconfig)?
 - how to report errors
 - links to samples
 - link to home page
 - info about threading
 etc.

Signed-off-by: Jan Safranek <jsafrane@redhat.com>
---

diff --git a/include/libcgroup.h b/include/libcgroup.h
index e53a00bd..543bd13a 100644
--- a/include/libcgroup.h
+++ b/include/libcgroup.h
@@ -27,4 +27,22 @@
 
 #undef _LIBCGROUP_H_INSIDE
 
+/*! \mainpage libcgroup
+ *
+ * \section intro_sec Introduction
+ *
+ * @c libcgroup is a library that abstracts the control group file system in Linux.
+ * It comes with various command-line tools and configuration files, see
+ * their man pages for details.
+ *
+ * This documentation provides description of @c libcgroup API. Read following
+ * sections, preferably in this order:
+ * -# @ref group_init "Initialization"
+ * -# @ref group_groups "Control Groups"
+ * -# @ref group_iterators "Iterators"
+ * -# @ref group_tasks "Manipulation with tasks"
+ * -# @ref group_config "Configuration"
+ * -# @ref group_errors "Error Handling"
+ */
+
 #endif /* _LIBCGROUP_H  */