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

Update config.h

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

diff --git a/include/libcgroup/config.h b/include/libcgroup/config.h
index eb5fe8cb..dc4719d8 100644
--- a/include/libcgroup/config.h
+++ b/include/libcgroup/config.h
@@ -9,12 +9,37 @@
 
 __BEGIN_DECLS
 
-/*
- * Config related stuff
+/**
+ * @defgroup group_config 5. Configuration
+ * @{
+ *
+ * @name Configuration file
+ * @{
+ *
+ * @c libcgroup can mount and create control groups and set their parameters as
+ * specified in a configuration file.
+ *
+ * @todo add this description?: These functions are mostly intended
+ * to be used by internal @c libcgroup tools, however they are fully supported
+ * and applications can benefit from them.
+ */
+
+/**
+ * Load configuration file and mount and create control groups described there.
+ * See cgconfig.conf man page for format of the file.
+ * @param pathname Name of the configuration file to load.
  */
 int cgroup_config_load_config(const char *pathname);
+
+/**
+ * Delete all control groups and unmount all hierarchies.
+ */
 int cgroup_unload_cgroups(void);
 
+/**
+ * @}
+ * @}
+ */
 __END_DECLS
 
 #endif /*_LIBCGROUP_CONFIG_H*/