From: Alan T. DeKok Date: Wed, 22 Feb 2023 16:53:50 +0000 (-0500) Subject: clean up doxygen complaints X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ecd454fa446a17c57530e08a584fddfaea4344a1;p=thirdparty%2Ffreeradius-server.git clean up doxygen complaints --- diff --git a/src/lib/server/cf_parse.h b/src/lib/server/cf_parse.h index 952f0bed062..eb71a1cdd58 100644 --- a/src/lib/server/cf_parse.h +++ b/src/lib/server/cf_parse.h @@ -85,7 +85,7 @@ typedef void conf_type_invalid; //!< Dummy type used to indicate invalid FR_TYP /** Check the #fr_type_t matches the destination data type * - * Validation macro to check the type of the pointer or offset #_p passed in + * Validation macro to check the type of the pointer or offset _p passed in * matches the #fr_type_t of the configuration item. * * Uses various magic builtin precompilation functions, so will likely only diff --git a/src/lib/server/cond_eval.c b/src/lib/server/cond_eval.c index c7879f293a3..4f6c83621c7 100644 --- a/src/lib/server/cond_eval.c +++ b/src/lib/server/cond_eval.c @@ -46,7 +46,7 @@ static int cond_realize_tmpl(request_t *request, fr_value_box_t **out, fr_value_box_t **to_free, tmpl_t *in, tmpl_t *other, fr_value_box_t *async); -/** Map keywords to #pair_list_t values +/** Map keywords to #fr_pair_list_t values */ static fr_table_num_sorted_t const cond_type_table[] = { { L("child"), COND_TYPE_CHILD }, @@ -335,7 +335,7 @@ done: return p - out; } -/** Turn a raw #tmpl_t into #fr_value_data_t, mostly. +/** Turn a raw #tmpl_t into #fr_value_box_t, mostly. * * It does nothing for lists, attributes, and precompiled regexes. * diff --git a/src/lib/server/method.c b/src/lib/server/method.c index a806e54689e..90f8695ba1a 100644 --- a/src/lib/server/method.c +++ b/src/lib/server/method.c @@ -17,7 +17,7 @@ /** * $Id$ * - * @file src/lib/server/methods.c + * @file src/lib/server/method.c * @brief Cannonical definition of abstract module methods. * * @copyright 2021 The FreeRADIUS server project diff --git a/src/lib/server/method.h b/src/lib/server/method.h index e367a8a5c15..7bbcc062b81 100644 --- a/src/lib/server/method.h +++ b/src/lib/server/method.h @@ -18,7 +18,7 @@ /** * $Id$ * - * @file lib/server/methods.h + * @file lib/server/method.h * @brief Cannonical definition of abstract module methods. * * Multiple schemes have been used to try and pick the default module diff --git a/src/lib/server/module_ctx.h b/src/lib/server/module_ctx.h index 60ec5bf0393..50d1f600bc4 100644 --- a/src/lib/server/module_ctx.h +++ b/src/lib/server/module_ctx.h @@ -18,7 +18,7 @@ /** * $Id$ * - * @file lib/server/module_call_ctx.h + * @file lib/server/module_ctx.h * @brief Temporary argument structures for module calls. * * These get used in various places where we may not want to include diff --git a/src/lib/server/tmpl_dcursor.c b/src/lib/server/tmpl_dcursor.c index 01770af8313..bbc95337091 100644 --- a/src/lib/server/tmpl_dcursor.c +++ b/src/lib/server/tmpl_dcursor.c @@ -18,7 +18,7 @@ * $Id$ * * @brief #fr_pair_t template functions - * @file src/lib/server/tmpl_cursor.c + * @file src/lib/server/tmpl_dcursor.c * * @ingroup AVP * @@ -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_nested_dcursor_t + * @param[in] uctx Context for evaluation - in this instance a #tmpl_dcursor_t * @return * - the next matching attribute * - NULL if none found diff --git a/src/lib/server/tmpl_eval.c b/src/lib/server/tmpl_eval.c index 99c59c9dcd6..e1e4fdcb417 100644 --- a/src/lib/server/tmpl_eval.c +++ b/src/lib/server/tmpl_eval.c @@ -87,13 +87,13 @@ static fr_dict_attr_autoload_t tmpl_dict_attr[] = { }; -/** Resolve attribute #pair_list_t value to an attribute list. +/** Resolve attribute #fr_pair_list_t value to an attribute list. * * The value returned is a pointer to the pointer of the HEAD of a #fr_pair_t list in the * #request_t. If the head of the list changes, the pointer will still be valid. * * @param[in] request containing the target lists. - * @param[in] list #pair_list_t value to resolve to #fr_pair_t list. Will be NULL if list + * @param[in] list #fr_pair_list_t value to resolve to #fr_pair_t list. Will be NULL if list * name couldn't be resolved. * @return a pointer to the HEAD of a list in the #request_t. * @@ -130,7 +130,7 @@ fr_pair_list_t *tmpl_list_head(request_t *request, fr_dict_attr_t const *list) * freed too. * * @param[in] request containing the target lists. - * @param[in] list #pair_list_t value to resolve to TALLOC_CTX. + * @param[in] list #fr_pair_list_t value to resolve to TALLOC_CTX. * @return * - TALLOC_CTX on success. * - NULL on failure. @@ -158,7 +158,7 @@ TALLOC_CTX *tmpl_list_ctx(request_t *request, fr_dict_attr_t const *list) * for the current #request_t. * * @param[in] request To resolve list in. - * @param[in] list #pair_list_t value to resolve to #fr_radius_packet_t. + * @param[in] list #fr_pair_list_t value to resolve to #fr_radius_packet_t. * @return * - #fr_radius_packet_t on success. * - NULL on failure. diff --git a/src/lib/server/tmpl_tokenize.c b/src/lib/server/tmpl_tokenize.c index 2cb83955be3..3fceeb91aef 100644 --- a/src/lib/server/tmpl_tokenize.c +++ b/src/lib/server/tmpl_tokenize.c @@ -369,9 +369,9 @@ void tmpl_debug(tmpl_t const *vpt) } } -/** @name Parse list and request qualifiers to #pair_list_t and #tmpl_request_ref_t values +/** @name Parse list and request qualifiers to #fr_pair_list_t and #tmpl_request_ref_t values * - * These functions also resolve #pair_list_t and #tmpl_request_ref_t values to #request_t + * These functions also resolve #fr_pair_list_t and #tmpl_request_ref_t values to #request_t * structs and the head of #fr_pair_t lists in those structs. * * For adding new #fr_pair_t to the lists, the #tmpl_list_ctx function can be used @@ -1964,14 +1964,14 @@ do_suffix: * @param[out] err May be NULL. Provides the exact error that the parser hit * when processing the attribute ref. * @param[out] out Where to write pointer to new #tmpl_t. - * @param[in] name of attribute including #tmpl_request_ref_t and #pair_list_t qualifiers. + * @param[in] name of attribute including #tmpl_request_ref_t and #fr_pair_list_t qualifiers. * @param[in] p_rules Formatting rules used to check for trailing garbage. * @param[in] t_rules Rules which control parsing: * - dict_def The default dictionary to use if attributes * are unqualified. * - request_def The default #request_t to set if no * #tmpl_request_ref_t qualifiers are found in name. - * - list_def The default list to set if no #pair_list_t + * - list_def The default list to set if no #fr_pair_list_t * qualifiers are found in the name. * - allow_unknown If true attributes in the format accepted by * #fr_dict_unknown_afrom_oid_substr will be allowed, @@ -2198,7 +2198,7 @@ ssize_t tmpl_afrom_attr_substr(TALLOC_CTX *ctx, tmpl_attr_error_t *err, * @param[out] err May be NULL. Provides the exact error that the parser hit * when processing the attribute ref. * @param[out] out Where to write pointer to new #tmpl_t. - * @param[in] name of attribute including #tmpl_request_ref_t and #pair_list_t qualifiers. + * @param[in] name of attribute including #tmpl_request_ref_t and #fr_pair_list_t qualifiers. * @param[in] t_rules Rules which control parsing. See tmpl_afrom_attr_substr() for details. * * @note Unlike #tmpl_afrom_attr_substr this function will error out if the entire diff --git a/src/lib/tls/base.c b/src/lib/tls/base.c index 0ee6583bcf1..2b74bf7c8c6 100644 --- a/src/lib/tls/base.c +++ b/src/lib/tls/base.c @@ -17,7 +17,7 @@ /** * $Id$ * - * @file tls/base.c + * @file src/lib/tls/base.c * @brief Initialise OpenSSL * * @copyright 2001 hereUare Communications, Inc. (raghud@hereuare.com) diff --git a/src/lib/tls/verify.c b/src/lib/tls/verify.c index 3f68cc3f011..3903553b74c 100644 --- a/src/lib/tls/verify.c +++ b/src/lib/tls/verify.c @@ -17,7 +17,7 @@ /** * $Id$ * - * @file tls/validate.c + * @file tls/verify.c * @brief Expose certificate OIDs as attributes, and call validation virtual * server to check cert is valid. * diff --git a/src/lib/util/pair.h b/src/lib/util/pair.h index fe44edfe252..5d6ffc3edd9 100644 --- a/src/lib/util/pair.h +++ b/src/lib/util/pair.h @@ -256,7 +256,7 @@ static inline bool vp_da_data_type_check(fr_pair_t *vp) return false; } -/** Iterate over the contents of a #pair_list_t +/** Iterate over the contents of a #fr_pair_list_t * * The iteration variable can be safely removed from the list at each pass. * diff --git a/src/lib/util/pair_legacy.c b/src/lib/util/pair_legacy.c index c69c7529437..88266a5e8c9 100644 --- a/src/lib/util/pair_legacy.c +++ b/src/lib/util/pair_legacy.c @@ -16,7 +16,7 @@ /** AVP manipulation and search API * - * @file src/lib/util/pair.c + * @file src/lib/util/pair_legacy.c * * @copyright 2000,2006,2015 The FreeRADIUS server project */ diff --git a/src/lib/util/pair_legacy.h b/src/lib/util/pair_legacy.h index c0ba33607a0..105fda81ffc 100644 --- a/src/lib/util/pair_legacy.h +++ b/src/lib/util/pair_legacy.h @@ -17,7 +17,7 @@ /** Legacy API functions - DO NOT USE IN NEW CODE * - * @file src/lib/util/dpair.h + * @file src/lib/util/pair_legacy.h * * @copyright 2015 The FreeRADIUS server project */ diff --git a/src/lib/util/pair_list_perf_test.c b/src/lib/util/pair_list_perf_test.c index 574b829d75e..a2a57af5db4 100644 --- a/src/lib/util/pair_list_perf_test.c +++ b/src/lib/util/pair_list_perf_test.c @@ -16,7 +16,7 @@ /** Performance tests for lists of fr_pair_t * - * @file src/bin/pair_list_perf_test.c + * @file src/lib/util/pair_list_perf_test.c * @author Nick Porter * * @copyright 2021 Network RADIUS SAS diff --git a/src/lib/util/rb_tests.c b/src/lib/util/rb_tests.c index f87e6855e8a..11e84054e70 100644 --- a/src/lib/util/rb_tests.c +++ b/src/lib/util/rb_tests.c @@ -16,7 +16,7 @@ /** Tests for rbtrees * - * @file src/lib/util/fr_rb_tree_tests.c + * @file src/lib/util/rb_tests.c * * @copyright 2021 Arran Cudbard-Bell */ diff --git a/src/lib/util/udp_queue.h b/src/lib/util/udp_queue.h index 5e51a17858e..24fda9b6eb6 100644 --- a/src/lib/util/udp_queue.h +++ b/src/lib/util/udp_queue.h @@ -18,7 +18,7 @@ /** * $Id$ * - * @file lib/server/udp_queue.h + * @file lib/util/udp_queue.h * @brief Handle queues of outgoing UDP packets * * @copyright 2021 Network RADIUS SAS (legal@networkradius.com) diff --git a/src/lib/util/value.c b/src/lib/util/value.c index ee4beef5f45..5b79cf1d702 100644 --- a/src/lib/util/value.c +++ b/src/lib/util/value.c @@ -5314,7 +5314,7 @@ ssize_t fr_value_box_print_quoted(fr_sbuff_t *out, fr_value_box_t const *data, f * they've been processed. * @param[in] flatten If true and we encounter a #FR_TYPE_GROUP, * we concat the contents of its children together. - * If false, the contents will be cast to #type. + * If false, the contents will be cast to #FR_TYPE_STRING. * @param[in] printable Convert 'octets' to printable strings. * @return * - >=0 the number of bytes written to the sbuff. @@ -5404,7 +5404,7 @@ ssize_t fr_value_box_list_concat_as_string(bool *tainted, fr_sbuff_t *sbuff, FR_ * they've been processed. * @param[in] flatten If true and we encounter a #FR_TYPE_GROUP, * we concat the contents of its children together. - * If false, the contents will be cast to #type. + * If false, the contents will be cast to #FR_TYPE_OCTETS. * @return * - >=0 the number of bytes written to the sbuff. * - <0 how many additional bytes we would have needed to @@ -5500,7 +5500,7 @@ ssize_t fr_value_box_list_concat_as_octets(bool *tainted, fr_dbuff_t *dbuff, FR_ * they've been processed. * @param[in] flatten If true and we encounter a #FR_TYPE_GROUP, * we concat the contents of its children together. - * If false, the contents will be cast to #type. + * If false, the contents will be cast to the given type. * @param[in] max_size of the value. * @return * - 0 on success. diff --git a/src/listen/control/radmin.c b/src/listen/control/radmin.c index f4f94e383d2..3f8ab61a296 100644 --- a/src/listen/control/radmin.c +++ b/src/listen/control/radmin.c @@ -17,7 +17,7 @@ /** * $Id$ * - * @file proto_control/radmin.c + * @file src/listen/control/radmin.c * @brief Control a running radiusd process. * * @copyright 2012-2016 The FreeRADIUS server project diff --git a/src/modules/rlm_ocsp/ocsp.c b/src/modules/rlm_ocsp/ocsp.c index b927a6da207..3a89e86d32c 100644 --- a/src/modules/rlm_ocsp/ocsp.c +++ b/src/modules/rlm_ocsp/ocsp.c @@ -17,7 +17,7 @@ /** * $Id$ * - * @file tls/ocsp.c + * @file rlm_ocsp/ocsp.c * @brief Validate client certificates using an OCSP service. * * @copyright 2006-2016 The FreeRADIUS server project diff --git a/src/process/tacacs/base.c b/src/process/tacacs/base.c index 5945a692029..b6f45e7cb7b 100644 --- a/src/process/tacacs/base.c +++ b/src/process/tacacs/base.c @@ -16,7 +16,7 @@ /** * $Id$ - * @file src/lib/process/tacacs/base.c + * @file src/process/tacacs/base.c * @brief TACACS+ handler. * @author Jorge Pereira * diff --git a/src/protocols/tftp/encode.c b/src/protocols/tftp/encode.c index 4cd4fe87531..e02b937132c 100644 --- a/src/protocols/tftp/encode.c +++ b/src/protocols/tftp/encode.c @@ -16,7 +16,7 @@ /** * $Id$ - * @file src/protocols/tftp/enoce.c + * @file src/protocols/tftp/encode.c * @brief Functions to encode TFTP packets. * @author Jorge Pereira *