From: Nick Porter <nick@portercomputing.co.uk>
Date: Tue, 2 May 2023 17:02:37 +0000 (+0100)
Subject: Doxygen tidying
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f89fb6b93a90131dc1dbafaaa4b4d7e75c2e2499;p=thirdparty%2Ffreeradius-server.git

Doxygen tidying
---

diff --git a/src/lib/server/cf_parse.h b/src/lib/server/cf_parse.h
index 12ef1df6fe8..1581ec230af 100644
--- a/src/lib/server/cf_parse.h
+++ b/src/lib/server/cf_parse.h
@@ -196,7 +196,7 @@ _Generic((_ct), \
 	.type = _type, \
 	.offset = FR_CONF_TYPE_CHECK((_type), &(((_struct *)NULL)->_field), offsetof(_struct, _field))
 
-/** CONF_PARSER which parses a single CONF_PAIR, writing the result to a field in a struct, recording if a default was used in <_field>_is_set
+/** CONF_PARSER which parses a single CONF_PAIR, writing the result to a field in a struct, recording if a default was used in `<_field>`_is_set
  *
  * @param[in] _name		of the CONF_PAIR to search for.
  * @param[in] _type		to parse the CONF_PAIR as.
@@ -215,6 +215,7 @@ _Generic((_ct), \
  * @param[in] _flags		any additional flags to set.
  * @param[in] _struct		containing the sub-struct to populate.
  * @param[in] _field		containing the sub-struct to populate.
+ * @param[in] _subcs		CONF_SECTION to parse.
  */
 #  define FR_CONF_OFFSET_SUBSECTION(_name, _flags, _struct, _field, _subcs) \
 	.name = _name, \
@@ -233,9 +234,9 @@ _Generic((_ct), \
 	.type = _type, \
 	.data = FR_CONF_TYPE_CHECK((_type), (_res_p), _res_p)
 
-/** CONF_PARSER which parses a single CONF_PAIR producing a single global result, recording if a default was used in <_res_p>_is_set
+/** CONF_PARSER which parses a single CONF_PAIR producing a single global result, recording if a default was used in `<_res_p>`_is_set
  *
- * @note is set state is recorded in variable <_res_p>_is_set.
+ * @note is set state is recorded in variable `<_res_p>`_is_set.
  *
  * @param[in] _name		of the CONF_PAIR to search for.
  * @param[in] _type		to parse the CONF_PAIR as.
@@ -268,7 +269,7 @@ _Generic((_ct), \
 
 /** CONF_PARSER entry which doesn't fill in a pointer or offset, but relies on functions to record values
  *
- * @param[in] _nand		name of pair to search for.
+ * @param[in] _name		name of pair to search for.
  * @param[in] _type		base type to parse pair as.
  * @param[in] _func		to use to record value.
  * @param[in] _dflt_func	to use to get defaults from a 3rd party library.
diff --git a/src/lib/server/cf_util.c b/src/lib/server/cf_util.c
index 020440f1dfa..e20cc121adc 100644
--- a/src/lib/server/cf_util.c
+++ b/src/lib/server/cf_util.c
@@ -2171,6 +2171,7 @@ void _cf_log_by_child(fr_log_type_t type, CONF_SECTION const *parent, char const
  * @param[in] type	of log message.
  * @param[in] file	src file the log message was generated in.
  * @param[in] line	number the log message was generated on.
+ * @param[in] f_rules	Line prefixes.
  * @param[in] fmt	of the message.
  * @param[in] ...	Message args.
  */
diff --git a/src/lib/server/cf_util.h b/src/lib/server/cf_util.h
index 08353effb33..12653689b8d 100644
--- a/src/lib/server/cf_util.h
+++ b/src/lib/server/cf_util.h
@@ -295,6 +295,7 @@ void		_cf_log_with_filename(fr_log_type_t type, CONF_ITEM const *ci, char const
  *
  * @param[in] _parent	CONF_SECTION.
  * @param[in] _child	string identifier.
+ * @param[in] _f_rules	Line prefixes.
  * @param[in] _fmt	of message.
  * @param[in] ...	arguments.
  */
diff --git a/src/lib/server/exec.c b/src/lib/server/exec.c
index b3c565e9ca2..b49ba06cad4 100644
--- a/src/lib/server/exec.c
+++ b/src/lib/server/exec.c
@@ -264,7 +264,7 @@ char **fr_exec_pair_to_env(request_t *request, fr_pair_list_t *env_pairs, bool e
  * We try to be fail-safe here. So if ANYTHING goes wrong, we exit with status 1.
  *
  * @param[in] argv		array of arguments to pass to child.
- * @param[in] envp		array of environment variables in form <attr>=<val>
+ * @param[in] envp		array of environment variables in form `<attr>=<val>`
  * @param[in] exec_wait		if true, redirect child process' stdin, stdout, stderr
  *				to the pipes provided, redirecting any to /dev/null
  *				where no pipe was provided.  If false redirect
diff --git a/src/lib/unlang/function.h b/src/lib/unlang/function.h
index 85924687967..30f27591bb7 100644
--- a/src/lib/unlang/function.h
+++ b/src/lib/unlang/function.h
@@ -66,6 +66,7 @@ int		unlang_function_clear(request_t *request) CC_HINT(warn_unused_result);
  *
  * @param[in] _request		The current request.
  * @param[in] _signal		The signal function to set.
+ * @param[in] _sigmask		Signals to block.
  * @return
  *	- 0 on success.
  *      - -1 on failure.
diff --git a/src/lib/unlang/module.c b/src/lib/unlang/module.c
index e1355f0fb4c..a9ad0408087 100644
--- a/src/lib/unlang/module.c
+++ b/src/lib/unlang/module.c
@@ -487,6 +487,7 @@ unlang_action_t unlang_module_yield_to_xlat(TALLOC_CTX *ctx, bool *p_success, fr
  *				types of xlats.
  * @param[in] resume		function to call when the XLAT expansion is complete.
  * @param[in] signal		function to call if a signal is received.
+ * @param[in] sigmask		Signals to block.
  * @param[in] rctx		to pass to the resume() and signal() callbacks.
  * @return
  *	- UNLANG_ACTION_PUSHED_CHILD