diff options
| author | Karel Zak | 2010-04-14 14:01:24 +0200 |
|---|---|---|
| committer | Karel Zak | 2010-06-03 15:20:12 +0200 |
| commit | 192c6aad9c8e6ae5c4a480f41b9359180a468150 (patch) | |
| tree | 92b53b67b4f94089b2e2e80c912ad7e9d5a1d722 /shlibs/mount/src/optstr.c | |
| parent | findmnt: add man page (diff) | |
| download | kernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.tar.gz kernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.tar.xz kernel-qcow2-util-linux-192c6aad9c8e6ae5c4a480f41b9359180a468150.zip | |
libmount: cleanup docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'shlibs/mount/src/optstr.c')
| -rw-r--r-- | shlibs/mount/src/optstr.c | 12 |
1 files changed, 11 insertions, 1 deletions
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 <string.h> #include <stdlib.h> #include <ctype.h> @@ -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) |