[master] Doxygen fixes and cleanups

4773.	[doc]		Fixed generating Doxygen documentation for functions
			annotated using certain macros.  Miscellaneous
			Doxygen-related cleanups. [RT #46276]

diff --git a/CHANGES b/CHANGES
index 72264ef26191b2a1b1a3321d36571e48aa2b368f..0246afed7c82094b2705212a02b26a5ba3462b44 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,7 @@
+4773.  [doc]           Fixed generating Doxygen documentation for functions
+                       annotated using certain macros.  Miscellaneous
+                       Doxygen-related cleanups. [RT #46276]
+
        --- 9.12.0b1 released ---
 
 4772.  [test]          Expanded unit testing framework for libns, using

diff --git a/bin/dnssec/dnssec-signzone.c b/bin/dnssec/dnssec-signzone.c
index f5df8cdeba67e7cb1080a698314e6ac7168b331c..5fea733c40f3e6ae4dd377aade164971ca9280a0 100644 (file)
--- a/bin/dnssec/dnssec-signzone.c
+++ b/bin/dnssec/dnssec-signzone.c
@@ -1958,7 +1958,7 @@ addnsec3(dns_name_t *name, dns_dbnode_t *node,
  * any NSEC3 records which have the same parameters as the chain we
  * are building.
  *
- * XXXMPA Should we also check that it of the form <hash>.<origin>?
+ * XXXMPA Should we also check that it of the form &lt;hash&gt;.&lt;origin&gt;?
  */
 static void
 nsec3clean(dns_name_t *name, dns_dbnode_t *node,

diff --git a/doc/doxygen/Doxyfile.in b/doc/doxygen/Doxyfile.in
index 28046f533e1f1d5c60f1432c6a21d823d1fa1778..f616f92928efd18ea29723f83418c40d1e895032 100644 (file)
--- a/doc/doxygen/Doxyfile.in
+++ b/doc/doxygen/Doxyfile.in
@@ -992,13 +992,13 @@ ENABLE_PREPROCESSING   = YES
 # compilation will be performed. Macro expansion can be done in a controlled 
 # way by setting EXPAND_ONLY_PREDEF to YES.
 
-MACRO_EXPANSION        = NO
+MACRO_EXPANSION        = YES
 
 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES 
 # then the macro expansion is limited to the macros specified with the 
 # PREDEFINED and EXPAND_AS_DEFINED tags.
 
-EXPAND_ONLY_PREDEF     = NO
+EXPAND_ONLY_PREDEF     = YES
 
 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files 
 # in the INCLUDE_PATH (see below) will be search if a #include is found.
@@ -1026,7 +1026,8 @@ INCLUDE_FILE_PATTERNS  =
 # undefined via #undef or recursively expanded use the := operator 
 # instead of the = operator.
 
-PREDEFINED             = 
+PREDEFINED             = "ISC_FORMAT_PRINTF(fmt, args)=" \
+                        "LIBRPZ_PF(f, l)="
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then 
 # this tag can be used to specify a list of macro names that should be expanded. 

diff --git a/lib/bind9/include/bind9/getaddresses.h b/lib/bind9/include/bind9/getaddresses.h
index ce08a5f762f76e46a90b53053908f85beb48ba8c..faa8afcd7df5edf30078b89eeccc4cdfefe2798b 100644 (file)
--- a/lib/bind9/include/bind9/getaddresses.h
+++ b/lib/bind9/include/bind9/getaddresses.h
@@ -43,7 +43,7 @@ bind9_getaddresses(const char *hostname, in_port_t port,
  * Returns:
  *\li  #ISC_R_SUCCESS
  *\li  #ISC_R_NOTFOUND
- *\li  #ISC_R_NOFAMILYSUPPORT - 'hostname' is an IPv6 address, and IPv6 is
+ *\li  #ISC_R_FAMILYNOSUPPORT - 'hostname' is an IPv6 address, and IPv6 is
  *             not supported.
  */
 

diff --git a/lib/dns/include/dns/db.h b/lib/dns/include/dns/db.h
index 04a1eaef99cf409597d40131cfc2df141ac9437e..2a8f315996faf42eab5842fbb081a9165b29ab0b 100644 (file)
--- a/lib/dns/include/dns/db.h
+++ b/lib/dns/include/dns/db.h
@@ -859,14 +859,6 @@ dns_db_findext(dns_db_t *db, const dns_name_t *name, dns_dbversion_t *version,
  *     \li     #ISC_R_SUCCESS                  The desired node and type were
  *                                             found.
  *
- *     \li     #DNS_R_WILDCARD                 The desired node and type were
- *                                             found after performing
- *                                             wildcard matching.  This is
- *                                             only returned if the
- *                                             #DNS_DBFIND_INDICATEWILD
- *                                             option is set; otherwise
- *                                             #ISC_R_SUCCESS is returned.
- *
  *     \li     #DNS_R_GLUE                     The desired node and type were
  *                                             found, but are glue.  This
  *                                             result can only occur if

diff --git a/lib/dns/include/dns/dlz_dlopen.h b/lib/dns/include/dns/dlz_dlopen.h
index 6e5f257a26dd9976369bb2dea335ae0aaccbb8c7..b7835bd954ce12b03462334c42304fd7ea934bf8 100644 (file)
--- a/lib/dns/include/dns/dlz_dlopen.h
+++ b/lib/dns/include/dns/dlz_dlopen.h
@@ -8,7 +8,7 @@
 
 /* $Id$ */
 
-/*! \file dns/dlz_open.h */
+/*! \file dns/dlz_dlopen.h */
 
 #ifndef DLZ_DLOPEN_H
 #define DLZ_DLOPEN_H

diff --git a/lib/dns/include/dns/dnstap.h b/lib/dns/include/dns/dnstap.h
index df3379cdf6c769aea798e403b66990f51b05d015..9af1f3f2ff4d16ac23fb912e414d43638be2bfa3 100644 (file)
--- a/lib/dns/include/dns/dnstap.h
+++ b/lib/dns/include/dns/dnstap.h
@@ -355,7 +355,7 @@ dns_dt_open(const char *filename, dns_dtmode_t mode,
  *\li  #ISC_R_NOMEMORY if the fstrm library was unable to allocate a
  *      reader or options structure
  *\li  #ISC_R_FAILURE if 'filename' could not be opened.
- *\li  #ISC_R_BADDNSTAP if 'filename' does not contain a dnstap
+ *\li  #DNS_R_BADDNSTAP if 'filename' does not contain a dnstap
  *      framestream.
  */
 

diff --git a/lib/dns/include/dns/librpz.h b/lib/dns/include/dns/librpz.h
index 75778a30067c926391ef7d13033cfbc07794e4d0..abf026afb9c9fa7c1cf369222911cde8f324599c 100644 (file)
--- a/lib/dns/include/dns/librpz.h
+++ b/lib/dns/include/dns/librpz.h
@@ -393,7 +393,7 @@ LIBDEF_F(clist_detach)
 /**
  * Create a librpz client handle.
  * @param[out] emsg: error message
- * @param: list of dnsrpzd connections
+ * @param clist: of dnsrpzd connections
  * @param cstr: string of configuration settings separated by ';' or '\n'
  * @param use_expired: true to not ignore expired zones
  * @return client handle or NULL if the handle could not be created
@@ -668,7 +668,7 @@ LIBDEF_F(db_info)
 /**
  * Start a context for listing the nodes and/or zones in the mapped file
  * @param[out] emsg: error message for false return or *rspp=NULL
- * @param[out[ rspp created context or NULL
+ * @param[out] rspp: created context or NULL
  * @param client context
  * @return false after error
  */

diff --git a/lib/dns/include/dns/name.h b/lib/dns/include/dns/name.h
index b5eb6a61459c8cf2573036d9fb79a825c360a137..0010a5175a041073fa54fbb1e0d29830de0f54f9 100644 (file)
--- a/lib/dns/include/dns/name.h
+++ b/lib/dns/include/dns/name.h
@@ -814,8 +814,6 @@ dns_name_fromtext(dns_name_t *name, isc_buffer_t *source,
  *\li  #DNS_R_EMPTYLABEL
  *\li  #DNS_R_LABELTOOLONG
  *\li  #DNS_R_BADESCAPE
- *\li  (#DNS_R_BADBITSTRING: should not be returned)
- *\li  (#DNS_R_BITSTRINGTOOLONG: should not be returned)
  *\li  #DNS_R_BADDOTTEDQUAD
  *\li  #ISC_R_NOSPACE
  *\li  #ISC_R_UNEXPECTEDEND

diff --git a/lib/dns/include/dns/order.h b/lib/dns/include/dns/order.h
index c58abb74a1fe59136d03985317b54ca8d05a95d6..624e056d76233027bd21ae017ee6b5bacc4d4303 100644 (file)
--- a/lib/dns/include/dns/order.h
+++ b/lib/dns/include/dns/order.h
@@ -44,8 +44,8 @@ dns_order_add(dns_order_t *order, const dns_name_t *name,
  * Requires:
  * \li 'order' to be valid.
  *\li  'name' to be valid.
- *\li  'mode' to be one of #DNS_RDATASERATTR_RANDOMIZE,
- *             #DNS_RDATASERATTR_RANDOMIZE or zero (#DNS_RDATASERATTR_CYCLIC).
+ *\li  'mode' to be one of #DNS_RDATASETATTR_RANDOMIZE,
+ *             #DNS_RDATASETATTR_FIXEDORDER or zero (#DNS_RDATASETATTR_CYCLIC).
  *
  * Returns:
  *\li  #ISC_R_SUCCESS

diff --git a/lib/dns/rbt.c b/lib/dns/rbt.c
index 4a02f3924ce311554efc276d6a801bdd9d83f932..0704d379df418757e3a003ca022082b2f2b603de 100644 (file)
--- a/lib/dns/rbt.c
+++ b/lib/dns/rbt.c
@@ -226,11 +226,11 @@ getdata(dns_rbtnode_t *node, file_header_t *header) {
  * The variable length stuff stored after the node has the following
  * structure.
  *
- *     <name_data>{1..255}<oldoffsetlen>{1}<offsets>{1..128}
+ *     &lt;name_data&gt;{1..255}&lt;oldoffsetlen&gt;{1}&lt;offsets&gt;{1..128}
  *
- * <name_data> contains the name of the node when it was created.
- * <oldoffsetlen> contains the length of <offsets> when the node was created.
- * <offsets> contains the offets into name for each label when the node was
+ * &lt;name_data&gt; contains the name of the node when it was created.
+ * &lt;oldoffsetlen&gt; contains the length of &lt;offsets&gt; when the node was created.
+ * &lt;offsets&gt; contains the offets into name for each label when the node was
  * created.
  */
 

diff --git a/lib/isc/include/isc/task.h b/lib/isc/include/isc/task.h
index 4b502fe61341b5190b89af0c47b32fcddff90b6e..5aa3282f9b9e8ce45f1573f0fdeb4977a83ab8ee 100644 (file)
--- a/lib/isc/include/isc/task.h
+++ b/lib/isc/include/isc/task.h
@@ -458,7 +458,7 @@ isc_task_onshutdown(isc_task_t *task, isc_taskaction_t action,
  *
  *\li  #ISC_R_SUCCESS
  *\li  #ISC_R_NOMEMORY
- *\li  #ISC_R_TASKSHUTTINGDOWN                 Task is shutting down.
+ *\li  #ISC_R_SHUTTINGDOWN                     Task is shutting down.
  */
 
 void

diff --git a/lib/isc/unix/include/isc/net.h b/lib/isc/unix/include/isc/net.h
index b9f567e8e12f6a90910accbdb9352c5d7d51b7b2..66f59cfeb040a95ceeadd840d6c208d369de3a59 100644 (file)
--- a/lib/isc/unix/include/isc/net.h
+++ b/lib/isc/unix/include/isc/net.h
@@ -175,6 +175,11 @@
 #define PF_INET6 AF_INET6
 #endif
 
+#ifndef INADDR_ANY
+/*% inaddr any */
+#define INADDR_ANY 0x00000000UL
+#endif
+
 #ifndef INADDR_LOOPBACK
 /*% inaddr loopback */
 #define INADDR_LOOPBACK 0x7f000001UL

diff --git a/lib/isc/win32/include/isc/net.h b/lib/isc/win32/include/isc/net.h
index 1d67c29eed9748eef7e4a921d4cc6165100e5ab1..db0b55afc206347fb78a3aec91ab0ba5143e34ef 100644 (file)
--- a/lib/isc/win32/include/isc/net.h
+++ b/lib/isc/win32/include/isc/net.h
@@ -87,6 +87,10 @@
  */
 #undef interface
 
+#ifndef INADDR_ANY
+#define INADDR_ANY 0x00000000UL
+#endif
+
 #ifndef INADDR_LOOPBACK
 #define INADDR_LOOPBACK 0x7f000001UL
 #endif

diff --git a/lib/isccfg/namedconf.c b/lib/isccfg/namedconf.c
index 8522860981ed9dd0b57c93b2350e2034cbb78999..849859c1c60e7c3174b1d7f9ffa3006104eb454b 100644 (file)
--- a/lib/isccfg/namedconf.c
+++ b/lib/isccfg/namedconf.c
@@ -1261,7 +1261,7 @@ static cfg_type_t cfg_type_resppadding = {
 
 /*%
  *  dnstap {
- *      <message type> [query | response] ;
+ *      &lt;message type&gt; [query | response] ;
  *      ...
  *  }
  *
@@ -1416,8 +1416,8 @@ static cfg_type_t cfg_type_dnstapoutput = {
 
 /*%
  *  response-policy {
- *     zone <string> [ policy (given|disabled|passthru|drop|tcp-only|
- *                                     nxdomain|nodata|cname <domain> ) ]
+ *     zone &lt;string&gt; [ policy (given|disabled|passthru|drop|tcp-only|
+ *                                     nxdomain|nodata|cname &lt;domain&gt; ) ]
  *                   [ recursive-only yes|no ] [ log yes|no ]
  *                   [ max-policy-ttl number ]
  *                   [ nsip-enable yes|no ] [ nsdname-enable yes|no ];

diff --git a/lib/ns/include/ns/lib.h b/lib/ns/include/ns/lib.h
index 3388267c307c5d14d7d0a903140ddccd3655cb80..6a9719853c7b716527a51077c9b268e7baa86afc 100644 (file)
--- a/lib/ns/include/ns/lib.h
+++ b/lib/ns/include/ns/lib.h
@@ -9,7 +9,7 @@
 #ifndef NS_LIB_H
 #define NS_LIB_H 1
 
-/*! \file ns/lib.h */
+/*! \file include/ns/lib.h */
 
 #include <isc/types.h>
 #include <isc/lang.h>

diff --git a/lib/ns/include/ns/stats.h b/lib/ns/include/ns/stats.h
index 61e68a197770073d5f822375a73bdb2e68c66185..32d5672e9e354c5501130cb13cf87cf20ea5b0f3 100644 (file)
--- a/lib/ns/include/ns/stats.h
+++ b/lib/ns/include/ns/stats.h
@@ -9,7 +9,7 @@
 #ifndef NS_STATS_H
 #define NS_STATS_H 1
 
-/*! \file ns/stats.h */
+/*! \file include/ns/stats.h */
 
 #include <ns/types.h>
 

diff --git a/lib/ns/include/ns/version.h b/lib/ns/include/ns/version.h
index 0e2f025dd97f51ab90799e2691c86a06cec47ab7..80750a9a7f3dad4991434b5b790ad191734d1548 100644 (file)
--- a/lib/ns/include/ns/version.h
+++ b/lib/ns/include/ns/version.h
@@ -6,7 +6,7 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-/*! \file ns/version.h */
+/*! \file include/ns/version.h */
 
 #include <isc/platform.h>