Commit 59d405a4 authored by Daniel Salzman's avatar Daniel Salzman

Set doxygen generation for knot_utils

refs #2137
parent 8a1f3ab1
......@@ -30,6 +30,7 @@ config.h
config.h.in
samples/knot.sample.conf
src/stamp-*
html/
# Generated sources
src/*.c
src/*.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
*/
......@@ -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
......
......@@ -20,7 +20,7 @@
*
* \brief dig/host executives
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Simple output formatting framework.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Networking abstraction for utilities.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Common utils parameters processing.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief resolv.conf processing.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -22,7 +22,7 @@
*
* \note Valid until the new libknot API is finished.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief dig executives.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -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);
......
......@@ -20,7 +20,7 @@
*
* \brief host executives.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief host command line parameters.
*
* \addtogroup utils
* \addtogroup knot_utils
* @{
*/
......
......@@ -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. */
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment