diff lxcstats.h @ 12:dbf24a82f625 default tip

Fix doxygen comments and add a Doxyfile
author Louis Opter <kalessin@kalessin.fr>
date Fri, 07 Jan 2011 21:49:31 +0100
parents cff6be97dae1
children
line wrap: on
line diff
--- a/lxcstats.h	Fri Jan 07 20:53:10 2011 +0100
+++ b/lxcstats.h	Fri Jan 07 21:49:31 2011 +0100
@@ -21,10 +21,14 @@
  *
  * This library is used to implement the LXC plugin for Collectd.
  *
- * @section see_also See Also
+ * @section sec_api API
+ *
+ * The lxcstats.h header contains everything you need.
  *
- *   - <a href="http://lxc.sourceforge.net/">LXC Containers</a>;
- *   - <a href="http://collectd.org/">Collectd</a>.
+ * @section sec_see_also See Also
+ *
+ *   - <a href="http://lxc.sourceforge.net/">LXC &mdash; Linux Containers</a>;
+ *   - <a href="http://collectd.org/">Collectd &mdash; The system statistics collection daemon</a>.
  */
 
 /**
@@ -36,19 +40,19 @@
  * This structure contains available statistics on a container.
  */
 struct              lxcst {
-    char            *name;      /*< Name of the container                               */
-    char            *cgroup_dir;/*< cgroup directory of the container                   */
+    char            *name;      /**< Name of the container                              */
+    char            *cgroup_dir;/**< cgroup directory of the container                  */
     struct  {
-        uint32_t    user;       /*< CPU time spent in userland                          */
-        uint32_t    system;     /*< CPU time spent in kernelland                        */
-        uint32_t    *percpu;    /*< CPU time per CPU (zero-terminated array or NULL)    */
-    }               cpuacct;    /*< CPU accounting in USER_HZ                           */
+        uint32_t    user;       /**< CPU time spent in userland                         */
+        uint32_t    system;     /**< CPU time spent in kernelland                       */
+        uint32_t    *percpu;    /**< CPU time per CPU (zero-terminated array or NULL)   */
+    }               cpuacct;    /**< CPU accounting in USER_HZ                          */
     struct {
-        uint64_t    used;       /*< RAM used by applications                            */
-        uint64_t    mapped;     /*< RAM used for mapped file (includes tmpfs/shmem)     */
-        uint64_t    cached;     /*< RAM cached by the kernel                            */
-        uint64_t    swapped;    /*< SWAP used                                           */
-    }               memory;     /*< Memory accounting in bytes                          */
+        uint64_t    used;       /**< RAM used by applications                           */
+        uint64_t    mapped;     /**< RAM used for mapped file (includes tmpfs/shmem)    */
+        uint64_t    cached;     /**< RAM cached by the kernel                           */
+        uint64_t    swapped;    /**< SWAP used                                          */
+    }               memory;     /**< Memory accounting in bytes                         */
 };
 
 /**