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 e53a00bd6d01ea239ac6223f4345beaa1a0248cc..543bd13a9f868f1294247ef34dfbecbf5eb82b72 100644 (file)
--- 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  */