diff options
| author | Karel Zak | 2014-11-26 19:13:57 +0100 |
|---|---|---|
| committer | Karel Zak | 2014-11-26 19:13:57 +0100 |
| commit | 705854f30773e463cd61796bc896f0c0053aa36d (patch) | |
| tree | d18873c270c080064419baf496f62b2aea5aaf94 /libfdisk/src/script.c | |
| parent | libfdisk: rename and move function (diff) | |
| download | kernel-qcow2-util-linux-705854f30773e463cd61796bc896f0c0053aa36d.tar.gz kernel-qcow2-util-linux-705854f30773e463cd61796bc896f0c0053aa36d.tar.xz kernel-qcow2-util-linux-705854f30773e463cd61796bc896f0c0053aa36d.zip | |
libfdisk: add API docs
Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libfdisk/src/script.c')
| -rw-r--r-- | libfdisk/src/script.c | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/libfdisk/src/script.c b/libfdisk/src/script.c index 2353cb8a2..83bda995d 100644 --- a/libfdisk/src/script.c +++ b/libfdisk/src/script.c @@ -4,8 +4,8 @@ /** * SECTION: script - * @title: Partition table script - * @short_description: text based description of partition table + * @title: Script + * @short_description: text based sfdisk compatible description of partition table * * The libfdisk scripts are based on original sfdisk script (dumps). Each * script has two parts: script headers and partition table entries @@ -50,6 +50,7 @@ static void fdisk_script_free_header(struct fdisk_script *dp, struct fdisk_scrip /** * fdisk_new_script: + * @cxt: context * * The script hold fdisk_table and additional information to read/write * script to the file. @@ -914,6 +915,8 @@ int fdisk_script_read_buffer(struct fdisk_script *dp, char *s) * fdisk_script_read_line: * @dp: script * @f: file + * @buf: buffer to store one line of the file + * @bufsz: buffer size * * Reads next line into dump. * @@ -960,7 +963,7 @@ int fdisk_script_read_line(struct fdisk_script *dp, FILE *f, char *buf, size_t b /** * fdisk_script_read_file: * @dp: script - * @f input file + * @f: input file * * Reads file @f into script @dp. * @@ -1038,11 +1041,11 @@ struct fdisk_script *fdisk_get_script(struct fdisk_context *cxt) /** * fdisk_apply_script_headers: * @cxt: context - * dp: script + * @dp: script * * Associte context @cxt with script @dp and creates a new empty disklabel. * - * Return: 0 on success, <0 on error. + * Returns: 0 on success, <0 on error. */ int fdisk_apply_script_headers(struct fdisk_context *cxt, struct fdisk_script *dp) { |