From: Daniel Salzman <daniel.salzman@nic.cz>
Date: Wed, 24 Apr 2019 14:58:13 +0000 (+0200)
Subject: zone: some documentation improvements
X-Git-Tag: v2.9.0~286^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=99080ba7948d6bffaf19e1951b76cd6574edb17e;p=thirdparty%2Fknot-dns.git

zone: some documentation improvements
---

diff --git a/src/knot/zone/zone-tree.h b/src/knot/zone/zone-tree.h
index 7fe8b593ab..35cd138a6c 100644
--- a/src/knot/zone/zone-tree.h
+++ b/src/knot/zone/zone-tree.h
@@ -20,7 +20,9 @@
 #include "knot/zone/node.h"
 
 enum {
+	/*! Indication of a zone tree with bi-nodes (two zone_node_t structures allocated for one node). */
 	ZONE_TREE_USE_BINODES = (1 << 0),
+	/*! If set, from each bi-node in the zone tree, the second zone_node_t is valid. */
 	ZONE_TREE_BINO_SECOND = (1 << 1),
 };
 
diff --git a/src/knot/zone/zone.h b/src/knot/zone/zone.h
index 440fe2f134..9525aefaa8 100644
--- a/src/knot/zone/zone.h
+++ b/src/knot/zone/zone.h
@@ -33,11 +33,11 @@ struct zone_update;
  * \brief Zone flags.
  */
 typedef enum zone_flag_t {
-	ZONE_FORCE_AXFR     = 1 << 0, /* Force AXFR as next transfer. */
-	ZONE_FORCE_RESIGN   = 1 << 1, /* Force zone re-sign. */
-	ZONE_FORCE_FLUSH    = 1 << 2, /* Force zone flush. */
-	ZONE_FORCE_KSK_ROLL = 1 << 3, /* Force KSK/CSK rollover. */
-	ZONE_FORCE_ZSK_ROLL = 1 << 4, /* Force ZSK rollover. */
+	ZONE_FORCE_AXFR     = 1 << 0, /*!< Force AXFR as next transfer. */
+	ZONE_FORCE_RESIGN   = 1 << 1, /*!< Force zone re-sign. */
+	ZONE_FORCE_FLUSH    = 1 << 2, /*!< Force zone flush. */
+	ZONE_FORCE_KSK_ROLL = 1 << 3, /*!< Force KSK/CSK rollover. */
+	ZONE_FORCE_ZSK_ROLL = 1 << 4, /*!< Force ZSK rollover. */
 } zone_flag_t;
 
 /*!