summaryrefslogtreecommitdiffstats
path: root/libfdisk/src/context.c
diff options
context:
space:
mode:
authorKarel Zak2014-11-26 19:13:57 +0100
committerKarel Zak2014-11-26 19:13:57 +0100
commit705854f30773e463cd61796bc896f0c0053aa36d (patch)
treed18873c270c080064419baf496f62b2aea5aaf94 /libfdisk/src/context.c
parentlibfdisk: rename and move function (diff)
downloadkernel-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/context.c')
-rw-r--r--libfdisk/src/context.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/libfdisk/src/context.c b/libfdisk/src/context.c
index 3e82f071b..42ad9f8a9 100644
--- a/libfdisk/src/context.c
+++ b/libfdisk/src/context.c
@@ -7,8 +7,8 @@
/**
* SECTION: context
- * @title: libfdisk handler
- * @short_description: stores infor about device, labels etc.
+ * @title: Context
+ * @short_description: stores info about device, labels etc.
*
* The library distinguish between three types of partitioning objects.
*
@@ -346,7 +346,7 @@ size_t fdisk_get_npartitions(struct fdisk_context *cxt)
*
* See also fdisk_is_label() macro in libfdisk.h.
*
- * Returns: return 1 if the current label is @l
+ * Returns: return 1 if the current label is @id
*/
int fdisk_is_labeltype(struct fdisk_context *cxt, enum fdisk_labeltype id)
{
@@ -724,6 +724,7 @@ int fdisk_set_unit(struct fdisk_context *cxt, const char *str)
/**
* fdisk_get_unit:
* @cxt: context
+ * @n: FDISK_PLURAL or FDISK_SINGULAR
*
* Returns: unit name.
*/
@@ -738,9 +739,9 @@ const char *fdisk_get_unit(struct fdisk_context *cxt, int n)
/**
* fdisk_use_cylinders:
- * @@cxt: context
+ * @cxt: context
*
- * Returns 1 if user wants to display in cylinders.
+ * Returns: 1 if user wants to display in cylinders.
*/
int fdisk_use_cylinders(struct fdisk_context *cxt)
{