Compare commits

...

3 Commits

Author SHA1 Message Date
Mark Andrews
0ba9fb147b silence various doxygen warnings/errors 2017-10-17 15:30:09 +11:00
Mark Andrews
48478f0893 add LIBRPZ_PF to PREDEFINED 2017-10-17 15:27:10 +11:00
Michał Kępień
e20e465933 [rt46276] Generate Doxygen documentation for all functions annotated with ISC_FORMAT_PRINTF() 2017-10-13 15:10:55 +02:00
17 changed files with 32 additions and 32 deletions

View File

@@ -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 * any NSEC3 records which have the same parameters as the chain we
* are building. * 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 static void
nsec3clean(dns_name_t *name, dns_dbnode_t *node, nsec3clean(dns_name_t *name, dns_dbnode_t *node,

View File

@@ -992,13 +992,13 @@ ENABLE_PREPROCESSING = YES
# compilation will be performed. Macro expansion can be done in a controlled # compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES. # 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 # 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 # then the macro expansion is limited to the macros specified with the
# PREDEFINED and EXPAND_AS_DEFINED tags. # 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 # 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. # 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 # undefined via #undef or recursively expanded use the := operator
# instead of 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 # 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. # this tag can be used to specify a list of macro names that should be expanded.

View File

@@ -43,7 +43,7 @@ bind9_getaddresses(const char *hostname, in_port_t port,
* Returns: * Returns:
*\li #ISC_R_SUCCESS *\li #ISC_R_SUCCESS
*\li #ISC_R_NOTFOUND *\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. * not supported.
*/ */

View File

@@ -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 * \li #ISC_R_SUCCESS The desired node and type were
* found. * 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 * \li #DNS_R_GLUE The desired node and type were
* found, but are glue. This * found, but are glue. This
* result can only occur if * result can only occur if

View File

@@ -8,7 +8,7 @@
/* $Id$ */ /* $Id$ */
/*! \file dns/dlz_open.h */ /*! \file dns/dlz_dlopen.h */
#ifndef DLZ_DLOPEN_H #ifndef DLZ_DLOPEN_H
#define DLZ_DLOPEN_H #define DLZ_DLOPEN_H

View File

@@ -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 *\li #ISC_R_NOMEMORY if the fstrm library was unable to allocate a
* reader or options structure * reader or options structure
*\li #ISC_R_FAILURE if 'filename' could not be opened. *\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. * framestream.
*/ */

View File

@@ -393,7 +393,7 @@ LIBDEF_F(clist_detach)
/** /**
* Create a librpz client handle. * Create a librpz client handle.
* @param[out] emsg: error message * @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 cstr: string of configuration settings separated by ';' or '\n'
* @param use_expired: true to not ignore expired zones * @param use_expired: true to not ignore expired zones
* @return client handle or NULL if the handle could not be created * @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 * 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] 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 * @param client context
* @return false after error * @return false after error
*/ */

View File

@@ -814,8 +814,6 @@ dns_name_fromtext(dns_name_t *name, isc_buffer_t *source,
*\li #DNS_R_EMPTYLABEL *\li #DNS_R_EMPTYLABEL
*\li #DNS_R_LABELTOOLONG *\li #DNS_R_LABELTOOLONG
*\li #DNS_R_BADESCAPE *\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 #DNS_R_BADDOTTEDQUAD
*\li #ISC_R_NOSPACE *\li #ISC_R_NOSPACE
*\li #ISC_R_UNEXPECTEDEND *\li #ISC_R_UNEXPECTEDEND

View File

@@ -44,8 +44,8 @@ dns_order_add(dns_order_t *order, const dns_name_t *name,
* Requires: * Requires:
* \li 'order' to be valid. * \li 'order' to be valid.
*\li 'name' to be valid. *\li 'name' to be valid.
*\li 'mode' to be one of #DNS_RDATASERATTR_RANDOMIZE, *\li 'mode' to be one of #DNS_RDATASETATTR_RANDOMIZE,
* #DNS_RDATASERATTR_RANDOMIZE or zero (#DNS_RDATASERATTR_CYCLIC). * #DNS_RDATASETATTR_FIXEDORDER or zero (#DNS_RDATASETATTR_CYCLIC).
* *
* Returns: * Returns:
*\li #ISC_R_SUCCESS *\li #ISC_R_SUCCESS

View File

@@ -226,11 +226,11 @@ getdata(dns_rbtnode_t *node, file_header_t *header) {
* The variable length stuff stored after the node has the following * The variable length stuff stored after the node has the following
* structure. * 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. * &lt;name_data&gt; contains the name of the node when it was created.
* <oldoffsetlen> contains the length of <offsets> when the node was created. * &lt;oldoffsetlen&gt; contains the length of &lt;offsets&gt; when the node was created.
* <offsets> contains the offets into name for each label when the node was * &lt;offsets&gt; contains the offets into name for each label when the node was
* created. * created.
*/ */

View File

@@ -458,7 +458,7 @@ isc_task_onshutdown(isc_task_t *task, isc_taskaction_t action,
* *
*\li #ISC_R_SUCCESS *\li #ISC_R_SUCCESS
*\li #ISC_R_NOMEMORY *\li #ISC_R_NOMEMORY
*\li #ISC_R_TASKSHUTTINGDOWN Task is shutting down. *\li #ISC_R_SHUTTINGDOWN Task is shutting down.
*/ */
void void

View File

@@ -175,6 +175,11 @@
#define PF_INET6 AF_INET6 #define PF_INET6 AF_INET6
#endif #endif
#ifndef INADDR_ANY
/*% inaddr any */
#define INADDR_ANY 0x00000000UL
#endif
#ifndef INADDR_LOOPBACK #ifndef INADDR_LOOPBACK
/*% inaddr loopback */ /*% inaddr loopback */
#define INADDR_LOOPBACK 0x7f000001UL #define INADDR_LOOPBACK 0x7f000001UL

View File

@@ -87,6 +87,10 @@
*/ */
#undef interface #undef interface
#ifndef INADDR_ANY
#define INADDR_ANY 0x00000000UL
#endif
#ifndef INADDR_LOOPBACK #ifndef INADDR_LOOPBACK
#define INADDR_LOOPBACK 0x7f000001UL #define INADDR_LOOPBACK 0x7f000001UL
#endif #endif

View File

@@ -1261,7 +1261,7 @@ static cfg_type_t cfg_type_resppadding = {
/*% /*%
* dnstap { * dnstap {
* <message type> [query | response] ; * &lt;message type&gt; [query | response] ;
* ... * ...
* } * }
* *
@@ -1416,8 +1416,8 @@ static cfg_type_t cfg_type_dnstapoutput = {
/*% /*%
* response-policy { * response-policy {
* zone <string> [ policy (given|disabled|passthru|drop|tcp-only| * zone &lt;string&gt; [ policy (given|disabled|passthru|drop|tcp-only|
* nxdomain|nodata|cname <domain> ) ] * nxdomain|nodata|cname &lt;domain&gt; ) ]
* [ recursive-only yes|no ] [ log yes|no ] * [ recursive-only yes|no ] [ log yes|no ]
* [ max-policy-ttl number ] * [ max-policy-ttl number ]
* [ nsip-enable yes|no ] [ nsdname-enable yes|no ]; * [ nsip-enable yes|no ] [ nsdname-enable yes|no ];

View File

@@ -9,7 +9,7 @@
#ifndef NS_LIB_H #ifndef NS_LIB_H
#define NS_LIB_H 1 #define NS_LIB_H 1
/*! \file ns/lib.h */ /*! \file include/ns/lib.h */
#include <isc/types.h> #include <isc/types.h>
#include <isc/lang.h> #include <isc/lang.h>

View File

@@ -9,7 +9,7 @@
#ifndef NS_STATS_H #ifndef NS_STATS_H
#define NS_STATS_H 1 #define NS_STATS_H 1
/*! \file ns/stats.h */ /*! \file include/ns/stats.h */
#include <ns/types.h> #include <ns/types.h>

View File

@@ -6,7 +6,7 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. * 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> #include <isc/platform.h>