# HG changeset patch
# User Louis Opter <kalessin@kalessin.fr>
# Date 1294429990 -3600
# Node ID cff6be97dae1d0e96cf8e17d5dde7da7d8d012e3
# Parent  3a1977ecccc79b24d0c69d6c81076d02b398dcd2
Add a mainpage for the doxygen documentation

diff -r 3a1977ecccc7 -r cff6be97dae1 lxcstats.h
--- a/lxcstats.h	Thu Jan 06 00:59:06 2011 +0100
+++ b/lxcstats.h	Fri Jan 07 20:53:10 2011 +0100
@@ -4,6 +4,30 @@
 # include <stdint.h>
 
 /**
+ * @mainpage liblxcstats API Reference
+ *
+ * @section sec_about About
+ *
+ * The liblxcstats returns resources usage statistics on the LXC Containers
+ * found on your system in a convenient data structure. LXC, Linux Containers,
+ * are like chroots on steroids.
+ *
+ * LXC uses the cgroup Linux kernel feature. Unlike other software
+ * virtualization technique (such as OpenVZ), LXC works on a vanilla Linux
+ * kernel.
+ *
+ * The code assumes that the cgroup hierarchy has been created by LXC. In the
+ * future this library could become a generic cgroup statistics library.
+ *
+ * This library is used to implement the LXC plugin for Collectd.
+ *
+ * @section see_also See Also
+ *
+ *   - <a href="http://lxc.sourceforge.net/">LXC Containers</a>;
+ *   - <a href="http://collectd.org/">Collectd</a>.
+ */
+
+/**
  * Opaque structure used as a context for all liblxcst functions.
  */
 typedef struct _lxcst_controller    lxcst_handle;