diff options
Diffstat (limited to 'include/libcgroup.h')
| -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 */ |