diff options
| author | Jan Safranek <jsafrane@redhat.com> | 2010-03-29 12:07:00 +0200 |
|---|---|---|
| committer | Jan Safranek <jsafrane@redhat.com> | 2010-03-29 12:07:00 +0200 |
| commit | 09957c91585eb01c968f771a8dbcf8a21963d740 (patch) | |
| tree | abf9785c6fac86bcb12de671567b98481dd183ab | |
| parent | a66a45ae500e2a94d0245c08791f219b583c7fc9 (diff) | |
| download | libcg-09957c91585eb01c968f771a8dbcf8a21963d740.tar.gz libcg-09957c91585eb01c968f771a8dbcf8a21963d740.tar.xz libcg-09957c91585eb01c968f771a8dbcf8a21963d740.zip | |
Add documentation main pagedevel/doxygen3
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>
| -rw-r--r-- | include/libcgroup.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/include/libcgroup.h b/include/libcgroup.h index e53a00b..543bd13 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 */ |