]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
libfdisk: add docs for init functions
authorKarel Zak <kzak@redhat.com>
Wed, 26 Nov 2014 10:13:11 +0000 (11:13 +0100)
committerKarel Zak <kzak@redhat.com>
Wed, 26 Nov 2014 10:13:11 +0000 (11:13 +0100)
libfdisk/src/init.c

index e147a17aadff2d7e7c0ce2cd221afa55476269d9..61acb0a4f57fbfd88d4db73d0fed81e94274ec99 100644 (file)
@@ -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)
 {