From: Karel Zak <kzak@redhat.com>
Date: Wed, 26 Nov 2014 10:13:11 +0000 (+0100)
Subject: libfdisk: add docs for init functions
X-Git-Tag: v2.26-rc1~175
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5d54d9f55b158e697aa0d54e511815c7e8dd5236;p=thirdparty%2Futil-linux.git

libfdisk: add docs for init functions
---

diff --git a/libfdisk/src/init.c b/libfdisk/src/init.c
index e147a17aad..61acb0a4f5 100644
--- a/libfdisk/src/init.c
+++ b/libfdisk/src/init.c
@@ -1,6 +1,14 @@
 
 #include "fdiskP.h"
 
+
+/**
+ * SECTION: init
+ * @title: Library initialization
+ * @short_description: initialize debug stuff
+ *
+ */
+
 UL_DEBUG_DEFINE_MASK(libfdisk);
 UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
 {
@@ -15,6 +23,7 @@ UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
 	{ "tab",	LIBFDISK_DEBUG_TAB,	"table utils"},
 	{ NULL, 0 }
 };
+
 /**
  * fdisk_init_debug:
  * @mask: debug mask (0xffff to enable full debuging)
@@ -24,6 +33,8 @@ UL_DEBUG_DEFINE_MASKNAMES(libfdisk) =
  *
  * Already initialized debugging stuff cannot be changed. It does not
  * have effect to call this function twice.
+ *
+ * It's strongly recommended to use fdisk_init_debug(0) in your code.
  */
 void fdisk_init_debug(int mask)
 {