libfdisk: cleanup gtk-docs warnings

Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/libfdisk/docs/libfdisk-sections.txt b/libfdisk/docs/libfdisk-sections.txt
index c0aaeaef8de6a032d004799ea5db0c56941a3f3f..62664ad87591d8d3c7522628af01d4b041136208 100644 (file)
--- a/libfdisk/docs/libfdisk-sections.txt
+++ b/libfdisk/docs/libfdisk-sections.txt
@@ -1,5 +1,6 @@
 <SECTION>
 <FILE>init</FILE>
+LIBFDISK_VERSION
 fdisk_init_debug
 </SECTION>
 
@@ -11,6 +12,7 @@ fdisk_warnx
 fdisk_set_ask
 <SUBSECTION>
 fdisk_ask
+fdisk_is_ask
 fdisk_ask_get_query
 fdisk_ask_get_type
 fdisk_ask_menu_get_default
@@ -44,6 +46,10 @@ fdisk_unref_ask
 
 <SECTION>
 <FILE>alignment</FILE>
+FDISK_ALIGN_DOWN
+FDISK_ALIGN_NEAREST
+FDISK_ALIGN_UP
+fdisk_sector_t
 fdisk_align_lba
 fdisk_align_lba_in_range
 fdisk_has_user_device_properties
@@ -81,6 +87,7 @@ fdisk_field_get_width
 fdisk_field_is_number
 <SUBSECTION>
 fdisk_label
+fdisk_is_label
 fdisk_label_get_field
 fdisk_label_get_field_by_name
 fdisk_label_get_fields_ids
@@ -185,6 +192,7 @@ fdisk_unref_partition
 
 <SECTION>
 <FILE>dos</FILE>
+DOS_FLAG_ACTIVE
 fdisk_dos_enable_compatible
 fdisk_dos_is_compatible
 fdisk_dos_move_begin
@@ -192,6 +200,8 @@ fdisk_dos_move_begin
 
 <SECTION>
 <FILE>sgi</FILE>
+SGI_FLAG_BOOT
+SGI_FLAG_SWAP
 fdisk_sgi_create_info
 fdisk_sgi_set_bootfile
 </SECTION>
@@ -199,6 +209,10 @@ fdisk_sgi_set_bootfile
 <SECTION>
 <FILE>gpt</FILE>
 fdisk_gpt_is_hybrid
+GPT_FLAG_REQUIRED
+GPT_FLAG_NOBLOCK
+GPT_FLAG_LEGACYBOOT
+GPT_FLAG_GUIDSPECIFIC
 </SECTION>
 
 <SECTION>
@@ -271,10 +285,11 @@ fdisk_get_optimal_iosize
 fdisk_get_parent
 fdisk_get_physector_size
 fdisk_get_sector_size
+FDISK_PLURAL
+FDISK_SINGULAR
 fdisk_get_unit
 fdisk_get_units_per_sector
 fdisk_has_label
-fdisk_has_user_device_properties
 fdisk_is_details
 fdisk_is_labeltype
 fdisk_is_listonly
@@ -296,6 +311,7 @@ fdisk_partname
 
 <SECTION>
 <FILE>iter</FILE>
+fdisk_iter
 fdisk_free_iter
 fdisk_iter_get_direction
 fdisk_new_iter

diff --git a/libfdisk/src/alignment.c b/libfdisk/src/alignment.c
index 67f1ddd08451f8822f7c4e337f71adfb60f57b15..1baee57a84b6a447b60e6514e01212841b4ecd15 100644 (file)
--- a/libfdisk/src/alignment.c
+++ b/libfdisk/src/alignment.c
@@ -12,7 +12,7 @@
  * @short_description: functions to align partitions and work with disk topology and geometry
  *
  * The libfdisk aligns the end of the partitions to make it possible to align
- * the next partition to the "grain" (see fdisk_get_grain()). The grain is
+ * the next partition to the "grain" (see fdisk_get_grain_size()). The grain is
  * usually 1MiB (or more for devices where optimal I/O is greater than 1MiB).
  *
  * It means that the library does not align strictly to physical sector size
@@ -65,7 +65,7 @@ static int lba_is_phy_aligned(struct fdisk_context *cxt, fdisk_sector_t lba)
  * @lba: address to align
  * @direction: FDISK_ALIGN_{UP,DOWN,NEAREST}
  *
- * This function aligns @lba to the "grain" (see fdisk_get_grain()). If the
+ * This function aligns @lba to the "grain" (see fdisk_get_grain_size()). If the
  * device uses alignment offset then the result is moved according the offset
  * to be on the physical boundary.
  *

diff --git a/libfdisk/src/label.c b/libfdisk/src/label.c
index 750cfca554009aa5ed2303fc331bb656364179a1..e4d15b216fcb73456d2ba1dff493c2ced9e7de2a 100644 (file)
--- a/libfdisk/src/label.c
+++ b/libfdisk/src/label.c
@@ -163,7 +163,7 @@ int fdisk_label_get_fields_ids(
  *
  * The field struct describes data stored in struct fdisk_partition. The info
  * about data is usable for example to generate human readable output (e.g.
- * fdisk 'p'rint command). See fdisk_partition_to_stirng() and fdisk code.
+ * fdisk 'p'rint command). See fdisk_partition_to_string() and fdisk code.
  *
  * Returns: pointer to static instance of the field.
  */

diff --git a/libfdisk/src/libfdisk.h.in b/libfdisk/src/libfdisk.h.in
index f82d5bd974ada70d0cfb2c2b12be1323114eecbc..54e0419eff92a2a1798fda4ef8d87916ce157cac 100644 (file)
--- a/libfdisk/src/libfdisk.h.in
+++ b/libfdisk/src/libfdisk.h.in
@@ -461,33 +461,50 @@ extern int fdisk_sgi_create_info(struct fdisk_context *cxt);
 
 /* gpt */
 
-/* GPT partition attributes */
-enum {
-       /* System partition (disk partitioning utilities must preserve the
-        * partition as is) */
-       GPT_FLAG_REQUIRED = 1,
-
-       /* EFI firmware should ignore the content of the partition and not try
-        * to read from it */
-       GPT_FLAG_NOBLOCK,
-
-       /* Legacy BIOS bootable  */
-       GPT_FLAG_LEGACYBOOT,
-
-       /* bites 48-63, Defined and used by the individual partition type.
-        *
-        * The flag GPT_FLAG_GUIDSPECIFIC forces libfdisk to ask (by ask API)
-        * for a bit number. If you want to toggle specific bit and avoid any
-        * dialog, then use the bit number (in range 48..63). For example:
-        *
-        * // start dialog to ask for bit number
-        * fdisk_toggle_partition_flag(cxt, n, GPT_FLAG_GUIDSPECIFIC);
-        *
-        * // toggle bit 60
-        * fdisk_toggle_partition_flag(cxt, n, 60);
-        */
-       GPT_FLAG_GUIDSPECIFIC
-};
+/*
+ * GPT partition attributes
+ */
+
+/**
+ * GPT_FLAG_REQUIRED:
+ *
+ * GPT attribute; marks a partition as system partition (disk
+ * partitioning utilities must preserve the partition as is)
+ */
+#define GPT_FLAG_REQUIRED      1
+
+/**
+ * GPT_FLAG_NOBLOCK:
+ *
+ * GPT attribute; EFI firmware should ignore the content of the
+ * partition and not try to read from it
+ */
+#define GPT_FLAG_NOBLOCK       2
+
+/**
+ * GPT_FLAG_LEGACYBOOT:
+ *
+ * GPT attribute; use the partition for legacy boot method
+ */
+#define GPT_FLAG_LEGACYBOOT    3
+
+/**
+ * GPT_FLAG_GUIDSPECIFIC:
+ *
+ * GPT attribute; for bites 48-63, defined and used by the individual partition
+ * type.
+ *
+ * The flag GPT_FLAG_GUIDSPECIFIC forces libfdisk to ask (by ask API)
+ * for a bit number. If you want to toggle specific bit and avoid any
+ * dialog, then use the bit number (in range 48..63). For example:
+ *
+ * // start dialog to ask for bit number
+ * fdisk_toggle_partition_flag(cxt, n, GPT_FLAG_GUIDSPECIFIC);
+ *
+ * // toggle bit 60
+ * fdisk_toggle_partition_flag(cxt, n, 60);
+ */
+#define GPT_FLAG_GUIDSPECIFIC  4
 
 extern int fdisk_gpt_is_hybrid(struct fdisk_context *cxt);
 

diff --git a/libfdisk/src/partition.c b/libfdisk/src/partition.c
index 8f8402716211582ac36ea396e903fa34a72603e4..f6305c07deba73bc18a04d2975771163d23115ef 100644 (file)
--- a/libfdisk/src/partition.c
+++ b/libfdisk/src/partition.c
@@ -172,7 +172,7 @@ int fdisk_partition_has_start(struct fdisk_partition *pa)
  * @a: partition
  * @b: partition
  *
- * Compares partitons according to start offset, See fdisk_sort_table().
+ * Compares partitons according to start offset, See fdisk_table_sort_partitions().
  *
  * Return: 0 if the same, <0 if @b greater, >0 if @a greater.
  */
@@ -294,7 +294,7 @@ int fdisk_partition_has_size(struct fdisk_partition *pa)
  * @enable: 0|1
  *
  * By default libfdisk aligns the size when add the new partition (by
- * fdisk_add_partrition()). If you want to disable this functionality use
+ * fdisk_add_partition()). If you want to disable this functionality use
  * @enable = 1.
  *
  * Returns: 0 on success, <0 on error.
@@ -376,7 +376,7 @@ int fdisk_partition_has_partno(struct fdisk_partition *pa)
  * @a: partition
  * @b: partition
  *
- * Compares partitons according to partition number See fdisk_sort_table().
+ * Compares partitons according to partition number See fdisk_table_sort_partitions().
  *
  * Return: 0 if the same, <0 if @b greater, >0 if @a greater.
  */

diff --git a/libfdisk/src/table.c b/libfdisk/src/table.c
index 9234814523ef4b0460cec212151345dd0fc3996b..858e258b16c06f21b64c607b1d39e8980177da9d 100644 (file)
--- a/libfdisk/src/table.c
+++ b/libfdisk/src/table.c
@@ -185,7 +185,7 @@ struct fdisk_partition *fdisk_table_get_partition(
  * @pa: new entry
  *
  * Adds a new entry to table and increment @pa reference counter. Don't forget to
- * use fdisk_unref_pa() after fdisk_table_add_partition() if you want to keep
+ * use fdisk_unref_partition() after fdisk_table_add_partition() if you want to keep
  * the @pa referenced by the table only.
  *
  * Returns: 0 on success or negative number in case of error.
@@ -529,7 +529,8 @@ done:
  * This function adds freespace (described by fdisk_partition) to @table, it
  * allocates a new table if the @table points to NULL.
  *
- * Note that free space smaller than grain (see fdisk_get_grain()) is ignored.
+ * Note that free space smaller than grain (see fdisk_get_grain_size()) is
+ * ignored.
 
  * Returns: 0 on success, otherwise, a corresponding error.
  */