From 192c6aad9c8e6ae5c4a480f41b9359180a468150 Mon Sep 17 00:00:00 2001 From: Karel Zak Date: Wed, 14 Apr 2010 14:01:24 +0200 Subject: libmount: cleanup docs Signed-off-by: Karel Zak --- shlibs/mount/src/optstr.c | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'shlibs/mount/src/optstr.c') diff --git a/shlibs/mount/src/optstr.c b/shlibs/mount/src/optstr.c index 3e4eb482d..ed40cacec 100644 --- a/shlibs/mount/src/optstr.c +++ b/shlibs/mount/src/optstr.c @@ -5,6 +5,16 @@ * GNU Lesser General Public License. */ +/** + * SECTION: optstr + * @title: Mount oprions string + * @short_description: low-level API for work with mount options + * + * This is simple and low-level API to work with mount options that are stored + * in string. This API is independent on the high-level options container and + * option maps. + */ + #include #include #include @@ -129,7 +139,7 @@ static int mnt_optstr_locate_option(char *optstr, const char *name, char **begin * * Parses the first option in @optstr or -1 in case of error. * - * Returns 0 on success, 1 at the end of @optstr or -1 in case of error. + * Returns: 0 on success, 1 at the end of @optstr or -1 in case of error. */ int mnt_optstr_next_option(char **optstr, char **name, size_t *namesz, char **value, size_t *valuesz) -- cgit v1.2.3-55-g7522