From 59d405a4032a76f36ae143d6235242e760ff427f Mon Sep 17 00:00:00 2001
From: Daniel Salzman <daniel.salzman@nic.cz>
Date: Thu, 24 Jan 2013 09:01:46 +0100
Subject: [PATCH] Set doxygen generation for knot_utils
refs #2137
---
.gitignore | 1 +
Doxy.page.h | 8 ++++++++
Doxyfile | 2 ++
src/utils/common/exec.h | 2 +-
src/utils/common/msg.h | 2 +-
src/utils/common/netio.h | 2 +-
src/utils/common/params.h | 2 +-
src/utils/common/resolv.h | 2 +-
src/utils/common/rr-serialize.h | 2 +-
src/utils/dig/dig_exec.h | 2 +-
src/utils/dig/dig_params.h | 7 +++++--
src/utils/host/host_exec.h | 2 +-
src/utils/host/host_params.h | 2 +-
src/utils/nsupdate/nsupdate_params.h | 4 ++--
14 files changed, 27 insertions(+), 13 deletions(-)
diff --git a/.gitignore b/.gitignore
index 1b897e7f53..b02db76a13 100644
--- a/.gitignore
+++ b/.gitignore
@@ -30,6 +30,7 @@ config.h
config.h.in
samples/knot.sample.conf
src/stamp-*
+html/
# Generated sources
src/*.c
src/*.h
diff --git a/Doxy.page.h b/Doxy.page.h
index 9d730240c9..64d891eca2 100644
--- a/Doxy.page.h
+++ b/Doxy.page.h
@@ -18,6 +18,9 @@
\defgroup ctl Control utility
\defgroup zone-load-dump Zone loading and dumping
\defgroup xfr Zone transfers
+\defgroup zone_scanner Zone scanner (core)
+\defgroup zone_scanner_test Zone scanner testing environment
+\defgroup knot_utils DNS utilities like host, dig and nsupdate
\mainpage Knot API documentation.
@@ -76,6 +79,8 @@ $ make pdf
<h2>Zone processing</h2>
- \ref zoneparser
- \ref zone-load-dump
+- \ref zone_scanner
+- \ref zone_scanner_test
<h2>Common library</h2>
- \ref common_lib
@@ -84,4 +89,7 @@ $ make pdf
<h2>Other modules</h2>
- \ref tests
- \ref ctl
+
+<h2>DNS utilities</h2>
+- \ref knot_utils
*/
diff --git a/Doxyfile b/Doxyfile
index 1a5bb0a1e8..54f6145e40 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -596,6 +596,8 @@ INPUT = src/common \
src/common \
src/knot \
src/zcompile \
+ src/zscanner \
+ src/utils \
Doxy.page.h
# This tag can be used to specify the character encoding of the source files
diff --git a/src/utils/common/exec.h b/src/utils/common/exec.h
index f9ff038e36..42ea3a8cf4 100644
--- a/src/utils/common/exec.h
+++ b/src/utils/common/exec.h
@@ -20,7 +20,7 @@
*
* \brief dig/host executives
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/common/msg.h b/src/utils/common/msg.h
index 9a576bde64..2f788b191f 100644
--- a/src/utils/common/msg.h
+++ b/src/utils/common/msg.h
@@ -20,7 +20,7 @@
*
* \brief Simple output formatting framework.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/common/netio.h b/src/utils/common/netio.h
index 19f7ffa14f..c70459a794 100644
--- a/src/utils/common/netio.h
+++ b/src/utils/common/netio.h
@@ -20,7 +20,7 @@
*
* \brief Networking abstraction for utilities.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/common/params.h b/src/utils/common/params.h
index 272fb266bd..cdf2b24220 100644
--- a/src/utils/common/params.h
+++ b/src/utils/common/params.h
@@ -20,7 +20,7 @@
*
* \brief Common utils parameters processing.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/common/resolv.h b/src/utils/common/resolv.h
index 64def44aaf..6cf09ed979 100644
--- a/src/utils/common/resolv.h
+++ b/src/utils/common/resolv.h
@@ -20,7 +20,7 @@
*
* \brief resolv.conf processing.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/common/rr-serialize.h b/src/utils/common/rr-serialize.h
index 44c4cd93cf..4dffa4f4b2 100644
--- a/src/utils/common/rr-serialize.h
+++ b/src/utils/common/rr-serialize.h
@@ -22,7 +22,7 @@
*
* \note Valid until the new libknot API is finished.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/dig/dig_exec.h b/src/utils/dig/dig_exec.h
index 7bae9fe03c..23e591de32 100644
--- a/src/utils/dig/dig_exec.h
+++ b/src/utils/dig/dig_exec.h
@@ -20,7 +20,7 @@
*
* \brief dig executives.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/dig/dig_params.h b/src/utils/dig/dig_params.h
index 37f9e84305..f83f871a3f 100644
--- a/src/utils/dig/dig_params.h
+++ b/src/utils/dig/dig_params.h
@@ -20,7 +20,7 @@
*
* \brief Dig command line parameters.
*
- * \addtogroup knot
+ * \addtogroup knot_utils
* @{
*/
@@ -29,7 +29,10 @@
#include "utils/common/params.h" // params_t
-
+/*! \brief dig-specific params data. */
+typedef struct {
+} dig_params_t;
+#define DIG_PARAM(p) ((dig_params_t*)p->d)
int host_params_parse(params_t *params, int argc, char *argv[]);
void host_params_clean(params_t *params);
diff --git a/src/utils/host/host_exec.h b/src/utils/host/host_exec.h
index b249cf22cd..e7c0df6619 100644
--- a/src/utils/host/host_exec.h
+++ b/src/utils/host/host_exec.h
@@ -20,7 +20,7 @@
*
* \brief host executives.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/host/host_params.h b/src/utils/host/host_params.h
index 0e5335b04b..7ab5835772 100644
--- a/src/utils/host/host_params.h
+++ b/src/utils/host/host_params.h
@@ -20,7 +20,7 @@
*
* \brief host command line parameters.
*
- * \addtogroup utils
+ * \addtogroup knot_utils
* @{
*/
diff --git a/src/utils/nsupdate/nsupdate_params.h b/src/utils/nsupdate/nsupdate_params.h
index 8c78fa3227..65661ad693 100644
--- a/src/utils/nsupdate/nsupdate_params.h
+++ b/src/utils/nsupdate/nsupdate_params.h
@@ -38,8 +38,8 @@
/*! Parser init string. */
#define PARSER_INIT_STR "$ORIGIN %s\n$TTL %u\n"
-/* nsupdate-specific params data */
-typedef struct nsupdate_params_t {
+/*! \brief nsupdate-specific params data. */
+typedef struct {
/*!< List of files with query data. */
list qfiles;
/*!< Current zone. */
--
GitLab