More doxygen cleanups

diff --git a/src/lib/ldap/connection.c b/src/lib/ldap/connection.c
index 35a74dfbce3eae5b7bb81f850aeffd2cb3451582..86f46e923bbf2dd648a9c69cc6cb6423a0755d8d 100644 (file)
--- a/src/lib/ldap/connection.c
+++ b/src/lib/ldap/connection.c
@@ -912,6 +912,7 @@ static int _thread_ldap_trunk_free(fr_ldap_thread_trunk_t *ttrunk)
  * @param[in] bind_dn          to make the connection as
  * @param[in] bind_password    for making connection
  * @param[in] request          currently being processed (only for debug messages)
+ * @param[in] config           LDAP config of the module requesting the connection.
  * @return
  *     - an existing or new connection matching the URI and bind DN
  *     - NULL on failure

diff --git a/src/lib/ldap/directory.c b/src/lib/ldap/directory.c
index 4b41b1fca6c9d7389143f7dab6f7add08dc1cf4c..90a98f752a97901a0dac265ba3eb8e5a0efb44ad 100644 (file)
--- a/src/lib/ldap/directory.c
+++ b/src/lib/ldap/directory.c
@@ -227,8 +227,10 @@ found:
 
 /** Parse results of search on rootDSE to gather data on LDAP server
  *
+ * @param[in] handle   on which the query was run.
  * @param[in] query    which requested the rootDSE.
  * @param[in] result   head of LDAP results message chain.
+ * @param[in] rctx     LDAP directory whose properties are to be populated.
  */
 static void ldap_trunk_directory_alloc_read(LDAP *handle, fr_ldap_query_t *query, LDAPMessage *result, void *rctx)
 {

diff --git a/src/lib/ldap/referral.c b/src/lib/ldap/referral.c
index 488b02f66ab26b1db54e5c40f85cac3d4579ef05..23ab0252f221f036f30d6ed322889a427bdf0da0 100644 (file)
--- a/src/lib/ldap/referral.c
+++ b/src/lib/ldap/referral.c
@@ -40,6 +40,7 @@ static int _fr_ldap_referral_free(fr_ldap_referral_t *referral)
 /** Allocate a new structure to handle an LDAP referral, setting the destructor
  *
  * @param[in] ctx      to allocate the referral in
+ * @param[in] request  the LDAP query relates to.
  * @return
  *     - a new referral structure on success
  *     - NULL on failure

diff --git a/src/lib/server/cf_parse.h b/src/lib/server/cf_parse.h
index eb71a1cdd58788a643613d51e16badf1c5a1436a..d085bb75bbde916dfdb008eadb7dbf8432312ed3 100644 (file)
--- a/src/lib/server/cf_parse.h
+++ b/src/lib/server/cf_parse.h
@@ -93,7 +93,7 @@ typedef void conf_type_invalid;               //!< Dummy type used to indicate invalid FR_TYP
  *
  * @note The warnings/errors emitted are usually awful.
  *
- * @param _t a #fr_type_t value with optional FR_TYPE_* flags.
+ * @param _t a #fr_type_t value with optional ``FR_TYPE_*`` flags.
  * @param _ct data type of global or struct field, obtained with ``__typeof__``.
  * @param _p Pointer or offset.
  */

diff --git a/src/lib/server/log.h b/src/lib/server/log.h
index 3a11b8f5c6b1d78828085ff1641d30e08b2abd12..71015233ecc69c51ac5e6aaa092178dcf0c8c8d6 100644 (file)
--- a/src/lib/server/log.h
+++ b/src/lib/server/log.h
@@ -175,7 +175,6 @@ void        log_global_free(void);
  * @param[in] _str_len         length of subject string. May be SIZE_MAX
  *                             to print the entire string.
  * @param[in] _marker_idx      Where to place the marker.  May be negative.
- * @param[in] _marker          text to print at marker_marker_idx.
  * @param[in] _line_prefix_fmt Prefix to add to all log lines.
  * @param[in] ...              Arguments for _line_prefix_fmt.
  */

diff --git a/src/lib/server/module.c b/src/lib/server/module.c
index 489488efed80eaca8356b4dd0afc45800e5d61be..0738caf43cd3329d66e58defb216f40c462c77ee 100644 (file)
--- a/src/lib/server/module.c
+++ b/src/lib/server/module.c
@@ -815,6 +815,7 @@ int modules_bootstrap(module_list_t const *ml)
  *
  * @param[in] ctx              Where to allocate the module name.
  * @param[out] out             Where to write a pointer to the instance name.
+ * @param[in] ml               Module list in which to find the parent.
  * @param[in] parent           of the module.
  * @param[in] inst_name                module's instance name.
  */
@@ -1080,6 +1081,7 @@ static int _module_list_free(module_list_t *ml)
  * If no more instances of the module exist the module be unloaded.
  *
  * @param[in] ctx      To allocate the list in.
+ * @param[in] name     of the list.
  * @return A new module list.
  */
 module_list_t *module_list_alloc(TALLOC_CTX *ctx, char const *name)

diff --git a/src/lib/server/module.h b/src/lib/server/module.h
index abbf4ee8fbba3502a51a5b3e2967dcc97d0bb896..a11c1980092bd6b19a81a6cf76dfac2bd7a6ae8c 100644 (file)
--- a/src/lib/server/module.h
+++ b/src/lib/server/module.h
@@ -56,6 +56,7 @@ typedef struct module_list_t                  module_list_t;
  * Is called when the module is listed in a particular section of a virtual
  * server, and the request has reached the module call.
  *
+ * @param[out] p_result                Result code of the module method.
  * @param[in] mctx             Holds global instance data, thread instance
  *                             data and call specific instance data.
  * @param[in] request          to process.

diff --git a/src/lib/server/module_method.c b/src/lib/server/module_method.c
index 1ce89c92c5c37946605152f1fd376a470b59bb02..8c3c3e27faf209f710ec00315f482147013cbb49 100644 (file)
--- a/src/lib/server/module_method.c
+++ b/src/lib/server/module_method.c
@@ -18,7 +18,7 @@
  * $Id$
  *
  * @file src/lib/server/module_method.c
- * @briefCentral module_method_name_t definitions
+ * @brief Central module_method_name_t definitions
  *
  * This file contains common module_method_t structures which may be
  * referenced within a #virtual_server_compile_t and a #module_t.

diff --git a/src/lib/server/password.c b/src/lib/server/password.c
index 5a33cc4b7fc5d43bad7e6c8a4d8c46c71a83f16b..e282b0eb9a351b0776ee6445a84e0c468f89ac32 100644 (file)
--- a/src/lib/server/password.c
+++ b/src/lib/server/password.c
@@ -51,6 +51,8 @@ typedef enum {
 /** Apply preprocessing logic to a password value
  *
  * @param[in] ctx      to allocate returned value in.
+ * @param[in] request  currently being processed.
+ * @param[in] in       Pair containing the password to process.
  * @
  */
 typedef fr_pair_t *(*password_preprocess_t)(TALLOC_CTX *ctx, request_t *request, fr_pair_t *in);

diff --git a/src/lib/server/request.h b/src/lib/server/request.h
index 85a27004daf7b6d12af132c48b58da9b7606dfd2..39b46acee15ee53b7d921568ec56205ae937035c 100644 (file)
--- a/src/lib/server/request.h
+++ b/src/lib/server/request.h
@@ -179,10 +179,10 @@ struct request_s {
 
        /** Pair lists associated with the request
         *
-        * @warn DO NOT allocate pairs directly beneath the root
-        *       or in the ctx of the request.
-        *       They MUST be allocated beneath their appropriate
-        *       list attribute.
+        * @warning DO NOT allocate pairs directly beneath the root
+        *          or in the ctx of the request.
+        *          They MUST be allocated beneath their appropriate
+        *          list attribute.
         */
        request_pair_lists_t    pair_list;      //!< Structure containing all pair lists.
 

diff --git a/src/lib/server/tmpl_dcursor.c b/src/lib/server/tmpl_dcursor.c
index bbc95337091f6a22dbbde57b86ae75e1732f24d6..e977d73f0a4d2a68c63f3e6d74eaca276c4b4014 100644 (file)
--- a/src/lib/server/tmpl_dcursor.c
+++ b/src/lib/server/tmpl_dcursor.c
@@ -47,7 +47,7 @@ void _tmpl_cursor_pool_init(tmpl_dcursor_ctx_t *cc)
  *
  * @param[in] list     being traversed.
  * @param[in] curr     item in the list to start tests from.
- * @param[in] uctx     Context for evaluation - in this instance a #tmpl_dcursor_t
+ * @param[in] uctx     Context for evaluation - in this instance a #tmpl_dcursor_nested_t
  * @return
  *     - the next matching attribute
  *     - NULL if none found
@@ -296,6 +296,8 @@ static int tmpl_dcursor_remove(UNUSED fr_dlist_head_t *list, void *to_remove, vo
  * @param[in] list             a nested list to start evaluating from.
  *                             May be the child list of a pair in the request's pair tree.
  * @param[in] vpt              specifying the #fr_pair_t type or list to iterate over.
+ * @param[in] build            Callback to build missing pairs.
+ * @param[in] uctx             to pass to build.
  * @return
  *     - First #fr_pair_t specified by the #tmpl_t.
  *     - NULL if no matching #fr_pair_t found, and NULL on error.

diff --git a/src/lib/server/tmpl_dcursor_tests.c b/src/lib/server/tmpl_dcursor_tests.c
index 307441936406137e28ea4a7e2399cdb25c4a304f..617a9cfc5633553bc8168fcd3746d91519a7b9cb 100644 (file)
--- a/src/lib/server/tmpl_dcursor_tests.c
+++ b/src/lib/server/tmpl_dcursor_tests.c
@@ -126,6 +126,7 @@ typedef struct {
 
 /** Initialise a tmpl using the _attr_str string, and return the first pair
  *
+ * @param[out] vp_out          where to write the returned pair
  * @param[in,out] vars         test variables
  * @param[in] request          the current request.
  * @param[in] ref              Attribute reference string.
@@ -154,6 +155,7 @@ int _tmpl_setup_and_cursor_init(fr_pair_t **vp_out, tmpl_dcursor_vars_t *vars, r
 
 /** Initialise a tmpl using the _attr_str string, and return the first pair
  *
+ * @param[out] vp_out          where to write the returned pair.
  * @param[in,out] vars         test variables
  * @param[in] request          the current request.
  * @param[in] ref              Attribute reference string.

diff --git a/src/lib/server/tmpl_tokenize.c b/src/lib/server/tmpl_tokenize.c
index 3fceeb91aefaa6c28105fa4de21f5473ab4895c1..bd212da5f35b45461c8869e793f1eb0158a2dcbf 100644 (file)
--- a/src/lib/server/tmpl_tokenize.c
+++ b/src/lib/server/tmpl_tokenize.c
@@ -49,7 +49,7 @@ RCSID("$Id$")
  *                     - REQUEST_PARENT,
  *                     - REQUEST_UNKNOWN
  */
-#define TMPL_REQUEST_REF_DEF(_name, _def) \
+#define TMPL_REQUEST_REF_DEF(_name, _ref) \
 static tmpl_request_t _name ## _entry = { \
        .entry = { \
                .entry = { \
@@ -57,7 +57,7 @@ static tmpl_request_t _name ## _entry = { \
                        .prev = &_name.head.entry \
                } \
        }, \
-       .request = _def \
+       .request = _ref \
 }; \
 FR_DLIST_HEAD(tmpl_request_list) _name = { \
        .head = { \
@@ -506,6 +506,7 @@ int8_t tmpl_request_ref_list_cmp(FR_DLIST_HEAD(tmpl_request_list) const *a, FR_D
  *
  * @param[in] ctx      to allocate request refs in.
  * @param[out] err     If !NULL where to write the parsing error.
+ * @param[in] out      The list to write to.
  * @param[in] in       Sbuff to read request references from.
  * @param[in] p_rules  Parse rules.
  * @param[in] t_rules  Default list and other rules.
@@ -665,6 +666,7 @@ static fr_slen_t tmpl_request_ref_list_from_substr(TALLOC_CTX *ctx, tmpl_attr_er
  *
  * @param[in] ctx      to allocate request refs in.
  * @param[out] err     If !NULL where to write the parsing error.
+ * @param[out] out     The new list.
  * @param[in] in       Sbuff to read request references from.
  * @return
  *     - >= 0 the number of bytes parsed.
@@ -1428,6 +1430,7 @@ fr_slen_t tmpl_attr_ref_from_unspecified_substr(tmpl_attr_t *ar, tmpl_attr_error
  * @param[out] err             Parse error.
  * @param[in,out] vpt          to append this reference to.
  * @param[in] parent           Last known parent.
+ * @param[in] namespace                in which the attribute will be resolved.
  * @param[in] name             to parse.
  * @param[in] at_rules         see tmpl_attr_afrom_attr_substr.
  * @return
@@ -3400,6 +3403,8 @@ ssize_t tmpl_regex_flags_substr(tmpl_t *vpt, fr_sbuff_t *in, fr_sbuff_term_t con
  * @param[in] existing_quote   Exiting quotation type.
  * @param[in] type             Cast type.
  * @param[in] enumv            Enumeration values.
+ * @param[in] unescaped                The unescaped value of an enumeration.
+ * @param[in] unescaped_len    Length of unescaped.
  */
 static inline CC_HINT(always_inline)
 fr_token_t tmpl_cast_quote(fr_token_t existing_quote,

diff --git a/src/lib/unlang/function.c b/src/lib/unlang/function.c
index 920e76ba872db258e83cb4e820aa7bb891814b57..f51e76528d2c5cbf3567f8f9dcebe0755ee6d8c5 100644 (file)
--- a/src/lib/unlang/function.c
+++ b/src/lib/unlang/function.c
@@ -266,6 +266,7 @@ int _unlang_function_repeat_set(request_t *request, unlang_function_t repeat, ch
  * @param[in] repeat_name      Name of the repeat function call (for debugging).
  * @param[in] signal           function to call if the request is signalled.
  * @param[in] signal_name      Name of the signal function call (for debugging).
+ * @param[in] top_frame                Return out of the unlang interpreter when popping this frame.
  * @param[in] uctx             to pass to func(s).
  * @return
  *     - 0 on success.

diff --git a/src/lib/unlang/function.h b/src/lib/unlang/function.h
index e5ff555e6aef4ff2e283ea87e00637b000e7909d..797c25ee9a99df42b7d88718c8ee364bc664d92f 100644 (file)
--- a/src/lib/unlang/function.h
+++ b/src/lib/unlang/function.h
@@ -38,6 +38,8 @@ extern "C" {
 
 /** A generic function pushed by a module or xlat to functions deeper in the C call stack to create resumption points
  *
+ * @param[in] p_result         The module return code.
+ * @param[in] priority         for the return code.
  * @param[in] request          The current request.
  * @param[in,out] uctx         Provided by whatever pushed the function.  Is opaque to the
  *                             interpreter, but should be usable by the function.
@@ -62,9 +64,8 @@ int           unlang_function_clear(request_t *request) CC_HINT(warn_unused_result);
  *
  * The function frame being modified must be at the top of the stack.
  *
- * @param[in] request          The current request.
- * @param[in] signal           The signal function to set.
- * @param[in] signal_name      Name of the signal function call (for debugging).
+ * @param[in] _request         The current request.
+ * @param[in] _signal          The signal function to set.
  * @return
  *     - 0 on success.
  *      - -1 on failure.
@@ -99,6 +100,7 @@ int          _unlang_function_repeat_set(request_t *request, unlang_function_t repeat, c
  * @param[in] _repeat          function to call going back down the stack (may be NULL).
  *                             This may be the same as func.
  * @param[in] _signal          function to call if the request is signalled.
+ * @param[in] _top_frame       Return out of the unlang interpreter when popping this frame.
  * @param[in] _uctx            to pass to func(s).
  * @return
  *     - 0 on success.

diff --git a/src/lib/unlang/interpret_synchronous.c b/src/lib/unlang/interpret_synchronous.c
index baf7e22305dbd289194e85614f9ad8c4d9849bb9..c8f41b4095e6cbd2a9f11f0e87e9d4f3d2158aaa 100644 (file)
--- a/src/lib/unlang/interpret_synchronous.c
+++ b/src/lib/unlang/interpret_synchronous.c
@@ -188,6 +188,8 @@ static unlang_interpret_synchronous_t *unlang_interpret_synchronous_alloc(TALLOC
  *     are what you're doing could be done better using one of the thread
  *     event loops.
  *
+ * @param[in] el       Event list for the temporary interpreter. If NULL a
+ *                     temporary list will be allocated.
  * @param[in] request  The current request.
  * @return One of the RLM_MODULE_* macros.
  */

diff --git a/src/lib/unlang/tmpl.h b/src/lib/unlang/tmpl.h
index ff10f6592c34bdbbe708ab5915c25badf9de1e01..e5f76abfff141a1678cc526df3875a42dd2bdb31 100644 (file)
--- a/src/lib/unlang/tmpl.h
+++ b/src/lib/unlang/tmpl.h
@@ -100,6 +100,7 @@ typedef void (*fr_unlang_tmpl_signal_t)(request_t *request, void *rctx, fr_state
  *
  * The resumed request cannot call the normal "authorize", etc. method.  It needs a separate callback.
  *
+ * @param[in] p_result         the module return code.
  * @param[in] request          the current request.
  * @param[in] rctx             a local context for the callback.
  * @return an unlang action.

diff --git a/src/lib/unlang/xlat.h b/src/lib/unlang/xlat.h
index 7c6fd973fe830d98de100e82e02752d8e38f21a1..90405ba936693ce32c0807b9695ec7b79e54c358 100644 (file)
--- a/src/lib/unlang/xlat.h
+++ b/src/lib/unlang/xlat.h
@@ -340,12 +340,12 @@ typedef int (*xlat_thread_detach_t)(xlat_thread_inst_ctx_t const *xctx);
                XLAT_ARGS_NEXT(_list, _g, _h); \
        } while (0);
 
-/** Trampoline macro for selecting which XLAT_ARGS_<num> macro to expand
+/** Trampoline macro for selecting which ``XLAT_ARGS_<num>`` macro to expand
  *
  *
  * @param[in] XLAT_ARGS_N      the name of the macro to expand.
- *                             Created by concating XLAT_ARGS_ + <number of variadic arguments>.
- * @param[in] _in              The input list of value boxes.
+ *                             Created by concating ``XLAT_ARGS_ + <number of variadic arguments>``.
+ * @param[in] _list            The input list of value boxes.
  * @param[in] ...              The variadic arguments themselves.
  */
 #define _XLAT_ARGS_X(XLAT_ARGS_N, _list, ...) XLAT_ARGS_N(_list, __VA_ARGS__)

diff --git a/src/lib/unlang/xlat_builtin.c b/src/lib/unlang/xlat_builtin.c
index 19daa5cc3fbef1963ca97d6e990480277df325cd..6361ee1d3b8ffb1ac8eec60f22e8f47147ed459d 100644 (file)
--- a/src/lib/unlang/xlat_builtin.c
+++ b/src/lib/unlang/xlat_builtin.c
@@ -322,6 +322,7 @@ static int xlat_arg_cmp_list_no_escape(xlat_arg_parser_t const a[], xlat_arg_par
 /** Verify xlat arg specifications are valid
  *
  * @param[in] arg      specification to validate.
+ * @param[in] last     Is this the last argument in the list.
  */
 static inline int xlat_arg_parser_validate(xlat_arg_parser_t const *arg, bool last)
 {

diff --git a/src/lib/unlang/xlat_eval.c b/src/lib/unlang/xlat_eval.c
index 32978f65eb9e57695eef32fad1ee7163ab4d8020..05eeac5fb5982a34cd83cbf2b82b87b2aac68ad2 100644 (file)
--- a/src/lib/unlang/xlat_eval.c
+++ b/src/lib/unlang/xlat_eval.c
@@ -182,6 +182,7 @@ static char *xlat_fmt_aprint(TALLOC_CTX *ctx, xlat_exp_t const *node)
  * @param[in] request  The current request.
  * @param[in] node     Being processed.
  * @param[in] args     from previous expansion.
+ * @param[in] line     Unused
  */
 static inline void xlat_debug_log_expansion(request_t *request, xlat_exp_t const *node, FR_DLIST_HEAD(fr_value_box_list) const *args, UNUSED int line)
 {
@@ -212,6 +213,7 @@ static inline void xlat_debug_log_expansion(request_t *request, xlat_exp_t const
 /** Output the list result of an expansion
  *
  * @param[in] request  The current request.
+ * @param[in] node     which was expanded.
  * @param[in] result   of the expansion.
  */
 static inline void xlat_debug_log_list_result(request_t *request, xlat_exp_t const *node, FR_DLIST_HEAD(fr_value_box_list) const *result)
@@ -226,6 +228,7 @@ static inline void xlat_debug_log_list_result(request_t *request, xlat_exp_t con
 /** Output the result of an expansion
  *
  * @param[in] request  The current request.
+ * @param[in] node     which was expanded.
  * @param[in] result   of the expansion.
  */
 static inline void xlat_debug_log_result(request_t *request, xlat_exp_t const *node, fr_value_box_t const *result)

diff --git a/src/lib/util/dcursor.h b/src/lib/util/dcursor.h
index d7c721843a25ca5c497b5abc33125abe23461a96..67d8612e3f493be4c56eab2401c7d86b5db7bc19 100644 (file)
--- a/src/lib/util/dcursor.h
+++ b/src/lib/util/dcursor.h
@@ -807,42 +807,42 @@ DIAG_OFF(unused-function)
 /** Expands to the type name used for the dcursor wrapper structure
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_dcursor_t
+ * @return ``<name>_dcursor_t``
  */
 #define FR_DCURSOR(_name) _name ## _dcursor_t
 
 /** Expands to the type name used for the dcursor iterator type
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_iter_t
+ * @return ``<name>_iter_t``
  */
 #define FR_DCURSOR_ITER(_name) _name ## _iter_t
 
 /** Expands to the type name used for the dcursor evaluator type
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_eval_t
+ * @return ``<name>_eval_t``
  */
 #define FR_DCURSOR_EVAL(_name) _name ## _eval_t
 
 /** Expands to the type name used for the dcursor insert function type
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_insert_t
+ * @return ``<name>_insert_t``
  */
 #define FR_DCURSOR_INSERT(_name) _name ## _insert_t
 
 /** Expands to the type name used for the dcursor remove function type
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_remove_t
+ * @return ``<name>_remove_t``
  */
 #define FR_DCURSOR_REMOVE(_name) _name ## _remove_t
 
 /** Expands to the type name used for the dcursor copy function type
  *
  * @param[in] _name    Prefix we add to type-specific structures.
- * @return <name>_copy_t
+ * @return ``<name>_copy_t``
  */
 #define FR_DCURSOR_COPY(_name) _name ## _copy_t
 

diff --git a/src/lib/util/log.c b/src/lib/util/log.c
index 79712742bf7d3ad8ed576d67ca59a8b4e7b175e0..9be259f1de09a388963612524e21f31be0b2664d 100644 (file)
--- a/src/lib/util/log.c
+++ b/src/lib/util/log.c
@@ -1240,6 +1240,7 @@ int fr_log_close(fr_log_t *log)
 /** Manipulate stderr and stdout so that was capture all data send to it from libraries
  *
  * @param[in] el       The event list we use to process logging data.
+ * @param[in] daemonize        Whether the server is starting as a daemon.
  * @return
  *     - 0 on success.
  *     - -1 on failure.

diff --git a/src/lib/util/lst.c b/src/lib/util/lst.c
index daba4805d9640d07d092e8d688c515de9c2749d5..33064d04b5cd068b0d9f9a89c11a6e326eb80a94 100644 (file)
--- a/src/lib/util/lst.c
+++ b/src/lib/util/lst.c
@@ -327,7 +327,7 @@ static inline CC_HINT(always_inline, nonnull) void lst_move(fr_lst_t *lst, fr_ls
        item_index_set(lst, data, index_reduce(lst, location));
 }
 
-/**  Add data to the bucket of a specified (sub)tree..
+/** Add data to the bucket of a specified (sub)tree.
  *
  */
 static void bucket_add(fr_lst_t *lst, stack_index_t stack_index, void *data)

diff --git a/src/lib/util/pair.c b/src/lib/util/pair.c
index 240df31cbf6c50cd92548bb15caef6dcbf576be3..5196c699930a01f95bfbb238b684e44799a7dc6d 100644 (file)
--- a/src/lib/util/pair.c
+++ b/src/lib/util/pair.c
@@ -1163,6 +1163,7 @@ static fr_dlist_head_t value_dlist = {
  * Filters can be applied later with fr_dcursor_filter_set.
  *
  * @note This is the only way to use a dcursor in non-const mode with fr_pair_list_t.
+ * @note - the list cannot be modified, and structural attributes are not returned.
  *
  * @param[out] cursor  to initialise.
  * @return
@@ -1211,6 +1212,8 @@ static void *_fr_pair_iter_next_dcursor_value(UNUSED fr_dlist_head_t *list, void
  *
  * Filters can be applied later with fr_dcursor_filter_set.
  *
+ * @note - the list cannot be modified, and structural attributes are not returned.
+  *
  * @param[out] cursor  to initialise.
  * @param[in] parent   to iterate over
  * @return

diff --git a/src/lib/util/pair.h b/src/lib/util/pair.h
index 0b3e71df8b108168c718d87f2b927d5783d30558..acc978194e78c4797fe5965eefefb581b7f0e108 100644 (file)
--- a/src/lib/util/pair.h
+++ b/src/lib/util/pair.h
@@ -610,28 +610,8 @@ fr_pair_t  *_fr_pair_dcursor_by_ancestor_init(fr_dcursor_t *cursor,
                                                   fr_pair_list_t const *list, fr_dict_attr_t const *da,
                                                   bool is_const) CC_HINT(nonnull);
 
-/** Initialises a special dcursor which returns only the values of the pairs
- *
- *  @note - the list cannot be modified, and structural attributes are not returned.
- *
- * @param[out] cursor  to initialise.
- * @return
- *     - NULL if src does not point to any items.
- *     - The value-box from the first pair in the list.
- */
 fr_value_box_t *fr_pair_dcursor_value_init(fr_dcursor_t *cursor) CC_HINT(nonnull);
 
-
-/** Initialises a special dcursor which returns only the values of a pair from a parent dcursor
- *
- *  @note - the list cannot be modified, and structural attributes are not returned.
- *
- * @param[out] cursor  to initialise.
- * @param[in] parent   dcursor which returns #fr_pair_t
- * @return
- *     - NULL if src does not point to any items.
- *     - The value-box from the first pair in the parent dcursor.
- */
 fr_value_box_t *fr_pair_dcursor_nested_init(fr_dcursor_t *cursor, fr_dcursor_t *parent) CC_HINT(nonnull);
 
 /** Compare two attributes using and operator.

diff --git a/src/lib/util/rb.c b/src/lib/util/rb.c
index 92f03caea5bfde976eec18da25a46b9e84e879e2..a7377cff8181a068bc29b48e5b8787068205babf 100644 (file)
--- a/src/lib/util/rb.c
+++ b/src/lib/util/rb.c
@@ -806,7 +806,7 @@ void *fr_rb_iter_init_inorder(fr_rb_iter_inorder_t *iter, fr_rb_tree_t *tree)
 
 /** Return the next node
  *
- * @param[in] iter     previously initialised with #fr_rb_iter_init
+ * @param[in] iter     previously initialised with #fr_rb_iter_init_inorder
  * @return
  *     - The next node.
  *     - NULL if no more nodes remain.
@@ -857,7 +857,7 @@ void *fr_rb_iter_next_inorder(fr_rb_iter_inorder_t *iter)
  *
  * @note Only makes sense for in-order traversals.
  *
- * @param[in] iter     previously initialised with #fr_rb_iter_inorder_init
+ * @param[in] iter     previously initialised with #fr_rb_iter_init_inorder
  */
 void fr_rb_iter_delete_inorder(fr_rb_iter_inorder_t *iter)
 {
@@ -897,7 +897,7 @@ void *fr_rb_iter_init_preorder(fr_rb_iter_preorder_t *iter, fr_rb_tree_t *tree)
 
 /** Return the next node
  *
- * @param[in] iter     previously initialised with #fr_rb_iter_init
+ * @param[in] iter     previously initialised with #fr_rb_iter_init_preorder
  * @return
  *     - The next node.
  *     - NULL if no more nodes remain.
@@ -981,7 +981,7 @@ void *fr_rb_iter_init_postorder(fr_rb_iter_postorder_t *iter, fr_rb_tree_t *tree
 
 /** Return the next node
  *
- * @param[in] iter     previously initialised with #fr_rb_iter_init
+ * @param[in] iter     previously initialised with #fr_rb_iter_init_postorder
  * @return
  *     - The next node.
  *     - NULL if no more nodes remain.

diff --git a/src/lib/util/strerror.c b/src/lib/util/strerror.c
index c3de10cdac3f76d323aad5bf135addaed5c17aac..47defa9a23330b3be6b6fd477b4d8ef382029494 100644 (file)
--- a/src/lib/util/strerror.c
+++ b/src/lib/util/strerror.c
@@ -190,6 +190,7 @@ static fr_log_entry_t *strerror_vprintf(char const *file, int line, char const *
  *
  * @param[in] file     the error occurred in.
  * @param[in] line     the error occurred on.
+ * @param[in] buffer   The log buffer to allocate memory from.
  * @param[in] fmt      printf style format string.
  * @param[in] ap       Arguments for the error string.
  *

diff --git a/src/process/tacacs/base.c b/src/process/tacacs/base.c
index b6f45e7cb7b0354ed10de96657f272c5f5aa94c7..81f79d9b563817d24ca2f849fedb8237d2539526 100644 (file)
--- a/src/process/tacacs/base.c
+++ b/src/process/tacacs/base.c
@@ -397,7 +397,7 @@ static int state_create(TALLOC_CTX *ctx, fr_pair_list_t *out, request_t *request
 /** Try and determine what the response packet type should be
  *
  * We check three sources:
- * - reply.<status_attr>
+ * - reply.``<status_attr>``
  * - reply.Packet-Type
  * - State machine packet type assignments for the section rcode
  *