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/partition.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/partition.c')
| -rw-r--r-- | libfdisk/src/partition.c | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/libfdisk/src/partition.c b/libfdisk/src/partition.c index d823857bf..7d4d57669 100644 --- a/libfdisk/src/partition.c +++ b/libfdisk/src/partition.c @@ -6,8 +6,8 @@ /** * SECTION: partition - * @title: partition abstraction - * @short_description: generic label independent partition + * @title: Partition + * @short_description: generic label independent partition abstraction * * The fdisk_partition provides label independent abstraction. The partitions * are not directly connected with partition table (label) data. Any change to @@ -73,7 +73,7 @@ void fdisk_reset_partition(struct fdisk_partition *pa) /** * fdisk_ref_partition: - * @tb: partition pointer + * @pa: partition pointer * * Incremparts reference counter. */ @@ -301,7 +301,7 @@ int fdisk_partition_size_explicit(struct fdisk_partition *pa, int enable) /** * fdisk_partition_set_partno: * @pa: partition - * @parto: partitin number (0 is the first partition, maximal is SIZE_MAX-1) + * @num: partitin number (0 is the first partition, maximal is SIZE_MAX-1) * * Note that zero is valid partno too. Use fdisk_partition_unset_partno() to * undefine the partno. @@ -594,6 +594,7 @@ int fdisk_partition_next_partno( /** * fdisk_partition_to_string: * @pa: partition + * @cxt: context * @id: field (FDISK_FIELD_*) * @data: returns string with allocated data * @@ -614,7 +615,7 @@ int fdisk_partition_next_partno( * * returns UUID for the first partition. * - * Returns 0 on success, otherwise, a corresponding error. + * Returns: 0 on success, otherwise, a corresponding error. */ int fdisk_partition_to_string(struct fdisk_partition *pa, struct fdisk_context *cxt, @@ -905,6 +906,7 @@ int fdisk_delete_all_partitions(struct fdisk_context *cxt) /** * fdisk_is_partition_used: + * @cxt: context * @n: partition number (0 is the first partition) * * This is faster than fdisk_get_partition() + fdisk_partition_is_used(). |