From: Karel Zak <kzak@redhat.com>
Date: Wed, 26 Nov 2014 10:34:57 +0000 (+0100)
Subject: libfdisk: add docs for SUN functions
X-Git-Tag: v2.26-rc1~171
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=fd979f5be7857b9fd448cc58aaac322fdf12c83c;p=thirdparty%2Futil-linux.git

libfdisk: add docs for SUN functions
---

diff --git a/libfdisk/src/sun.c b/libfdisk/src/sun.c
index 2ef28031d5..04bf0dda17 100644
--- a/libfdisk/src/sun.c
+++ b/libfdisk/src/sun.c
@@ -20,6 +20,14 @@
 #include "pt-sun.h"
 #include "all-io.h"
 
+
+/**
+ * SECTION: sun
+ * @title: SUN functions
+ * @short_description: SUN disklabel specific functions
+ *
+ */
+
 /*
  * in-memory fdisk SUN stuff
  */
@@ -810,7 +818,15 @@ static int sun_get_partition(struct fdisk_context *cxt, size_t n,
 	return 0;
 }
 
-
+/**
+ * fdisk_sun_set_alt_cyl:
+ * @cxt: context
+ *
+ * Sets number of alternative cylinders. This function uses libfdisk Ask API
+ * for dialog with user.
+ *
+ * Returns: 0 on success, <0 on error.
+ */
 int fdisk_sun_set_alt_cyl(struct fdisk_context *cxt)
 {
 	struct sun_disklabel *sunlabel = self_disklabel(cxt);
@@ -827,6 +843,15 @@ int fdisk_sun_set_alt_cyl(struct fdisk_context *cxt)
 	return 0;
 }
 
+/**
+ * fdisk_sun_set_xcyl:
+ * @cxt: context
+ *
+ * Sets number of extra sectors per cylinder. This function uses libfdisk Ask API
+ * for dialog with user.
+ *
+ * Returns: 0 on success, <0 on error.
+ */
 int fdisk_sun_set_xcyl(struct fdisk_context *cxt)
 {
 	struct sun_disklabel *sunlabel = self_disklabel(cxt);
@@ -842,6 +867,15 @@ int fdisk_sun_set_xcyl(struct fdisk_context *cxt)
 	return 0;
 }
 
+/**
+ * fdisk_sun_set_ilfact:
+ * @cxt: context
+ *
+ * Sets interleave factor. This function uses libfdisk Ask API for dialog with
+ * user.
+ *
+ * Returns: 0 on success, <0 on error.
+ */
 int fdisk_sun_set_ilfact(struct fdisk_context *cxt)
 {
 	struct sun_disklabel *sunlabel = self_disklabel(cxt);
@@ -857,6 +891,15 @@ int fdisk_sun_set_ilfact(struct fdisk_context *cxt)
 	return 0;
 }
 
+/**
+ * fdisk_sun_set_rspeed
+ * @cxt: context
+ *
+ * Sets rotation speed. This function uses libfdisk Ask API for dialog with
+ * user.
+ *
+ * Returns: 0 on success, <0 on error.
+ */
 int fdisk_sun_set_rspeed(struct fdisk_context *cxt)
 {
 	struct sun_disklabel *sunlabel = self_disklabel(cxt);
@@ -872,6 +915,15 @@ int fdisk_sun_set_rspeed(struct fdisk_context *cxt)
 	return 0;
 }
 
+/**
+ * fdisk_sun_set_pcylcount
+ * @cxt: context
+ *
+ * Sets number of physical cylinders. This function uses libfdisk Ask API for
+ * dialog with user.
+ *
+ * Returns: 0 on success, <0 on error.
+ */
 int fdisk_sun_set_pcylcount(struct fdisk_context *cxt)
 {
 	struct sun_disklabel *sunlabel = self_disklabel(cxt);