From: Arran Cudbard-Bell Date: Thu, 12 Nov 2020 01:29:41 +0000 (-0600) Subject: Doxygen X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=4585ab5db716e9690a840a217669c4775de18947;p=thirdparty%2Ffreeradius-server.git Doxygen --- diff --git a/src/lib/eap_aka_sim/state_machine.c b/src/lib/eap_aka_sim/state_machine.c index a6186b4d901..9ef2e932e5c 100644 --- a/src/lib/eap_aka_sim/state_machine.c +++ b/src/lib/eap_aka_sim/state_machine.c @@ -623,13 +623,13 @@ done: * * Call the appropriate sections to persist those values. * + * @param[out] p_result Result of calling the module. * @param[in] mctx Module calling ctx. * @param[in] request the current request. * @param[in] eap_session the EAP session * @param[in] state_enter state entry function for the * state to transition to *after* the current * state. - * @return RLM_MODULE_HANDLED. */ static unlang_action_t session_and_pseudonym_store(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request, eap_session_t *eap_session, @@ -754,13 +754,13 @@ static unlang_action_t pseudonym_clear_resume(rlm_rcode_t *p_result, module_ctx_ * any identities that were provided during those rounds, as the supplicant * will have discarded them. * + * @param[out] p_result Result of calling the module. * @param[in] mctx module calling ctx. * @param[in] request the current request. * @param[in] eap_session the current EAP session * @param[in] state_enter state entry function for the * state to transition to *after* the current * state. - * @return RLM_MODULE_HANDLED. */ static unlang_action_t session_and_pseudonym_clear(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request, eap_session_t *eap_session, @@ -1611,12 +1611,12 @@ static unlang_action_t sim_challenge_request_compose(rlm_rcode_t *p_result, modu * or can't perform fast resumption, we need to request the full identity from * the supplicant. * + * @param[out] p_result Result of calling the module, one of: + * - RLM_MODULE_HANDLED on success. + * - anything else on failure. * @param[in] mctx module calling ctx. * @param[in] request The current subrequest. * @param[in] eap_session to continue. - * @return - * - RLM_MODULE_HANDLED on success. - * - anything else on failure. */ static unlang_action_t aka_identity_request_send(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request, eap_session_t *eap_session) @@ -1692,12 +1692,12 @@ static unlang_action_t aka_identity_request_send(rlm_rcode_t *p_result, module_c * or can't perform fast resumption, we need to request the full identity from * the supplicant. * + * @param[out] p_result Result of calling the module, one of: + * - RLM_MODULE_HANDLED on success. + * - anything else on failure. * @param[in] mctx module calling context. * @param[in] request The current subrequest. * @param[in] eap_session to continue. - * @return - * - RLM_MODULE_HANDLED on success. - * - anything else on failure. */ static unlang_action_t sim_start_request_send(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request, eap_session_t *eap_session) diff --git a/src/modules/rlm_couchbase/rlm_couchbase.c b/src/modules/rlm_couchbase/rlm_couchbase.c index 2bfe706def1..f89020637c0 100644 --- a/src/modules/rlm_couchbase/rlm_couchbase.c +++ b/src/modules/rlm_couchbase/rlm_couchbase.c @@ -93,9 +93,9 @@ fr_dict_attr_autoload_t rlm_couchbase_dict_attr[] = { * document is found it will be parsed and the containing value pairs will be * injected into the request. * - * @param mctx module calling context. - * @param request The authorization request. - * @return Operation status (#rlm_rcode_t). + * @param[out] p_result Operation status (#rlm_rcode_t). + * @param[in] mctx module calling context. + * @param[in] request The authorization request. */ static unlang_action_t mod_authorize(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request) { @@ -229,9 +229,9 @@ finish: * will be merged with the currently existing data. When conflicts arrise the new attribute * value will replace or be added to the existing value. * - * @param mctx module calling context. - * @param request The accounting request object. - * @return Operation status (#rlm_rcode_t). + * @param[out] p_result Result of calling the module. + * @param mctx module calling context. + * @param request The accounting request object. */ static unlang_action_t mod_accounting(rlm_rcode_t *p_result, module_ctx_t const *mctx, request_t *request) { diff --git a/src/modules/rlm_eap/rlm_eap.c b/src/modules/rlm_eap/rlm_eap.c index b2ab23d6b05..9e56782c41b 100644 --- a/src/modules/rlm_eap/rlm_eap.c +++ b/src/modules/rlm_eap/rlm_eap.c @@ -364,15 +364,15 @@ static void mod_authenticate_cancel(UNUSED module_ctx_t const *mctx, request_t * /** Process the result of calling a submodule * + * @param[out] p_result Result of calling the module, one of: + * - RLM_MODULE_INVALID if the request or EAP session state is invalid. + * - RLM_MODULE_OK if this round succeeded. + * - RLM_MODULE_HANDLED if we're done with this round. + * - RLM_MODULE_REJECT if the user should be rejected. * @param[in] request The current request. * @param[in] mctx module calling ctx. * @param[in] eap_session the EAP session * @param[in] result the input result from the submodule - * @return - * - RLM_MODULE_INVALID if the request or EAP session state is invalid. - * - RLM_MODULE_OK if this round succeeded. - * - RLM_MODULE_HANDLED if we're done with this round. - * - RLM_MODULE_REJECT if the user should be rejected. */ static unlang_action_t mod_authenticate_result(rlm_rcode_t *p_result, UNUSED module_ctx_t const *mctx, request_t *request, eap_session_t *eap_session, rlm_rcode_t result) diff --git a/src/modules/rlm_ldap/groups.c b/src/modules/rlm_ldap/groups.c index 2cd6aba6a25..7c06b0d8fdf 100644 --- a/src/modules/rlm_ldap/groups.c +++ b/src/modules/rlm_ldap/groups.c @@ -539,11 +539,11 @@ finish: /** Query the LDAP directory to check if a group object includes a user object as a member * - * @param[in] inst rlm_ldap configuration. - * @param[in] request Current request. - * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect. - * @param[in] check vp containing the group value (name or dn). - * @return One of the RLM_MODULE_* values. + * @param[out] p_result Result of calling the module. + * @param[in] inst rlm_ldap configuration. + * @param[in] request Current request. + * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect. + * @param[in] check vp containing the group value (name or dn). */ unlang_action_t rlm_ldap_check_groupobj_dynamic(rlm_rcode_t *p_result, rlm_ldap_t const *inst, request_t *request, fr_ldap_connection_t **pconn, fr_pair_t *check) @@ -639,12 +639,12 @@ unlang_action_t rlm_ldap_check_groupobj_dynamic(rlm_rcode_t *p_result, rlm_ldap_ /** Query the LDAP directory to check if a user object is a member of a group * - * @param[in] inst rlm_ldap configuration. - * @param[in] request Current request. - * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect. - * @param[in] dn of user object. - * @param[in] check vp containing the group value (name or dn). - * @return One of the RLM_MODULE_* values. + * @param[out] p_result Result of calling the module. + * @param[in] inst rlm_ldap configuration. + * @param[in] request Current request. + * @param[in,out] pconn to use. May change as this function calls functions which auto re-connect. + * @param[in] dn of user object. + * @param[in] check vp containing the group value (name or dn). */ unlang_action_t rlm_ldap_check_userobj_dynamic(rlm_rcode_t *p_result, rlm_ldap_t const *inst, request_t *request, fr_ldap_connection_t **pconn, @@ -828,11 +828,10 @@ finish: /** Check group membership attributes to see if a user is a member. * - * @param[in] inst rlm_ldap configuration. - * @param[in] request Current request. - * @param[in] check vp containing the group value (name or dn). - * - * @return One of the RLM_MODULE_* values. + * @param[out] p_result Result of calling the module. + * @param[in] inst rlm_ldap configuration. + * @param[in] request Current request. + * @param[in] check vp containing the group value (name or dn). */ unlang_action_t rlm_ldap_check_cached(rlm_rcode_t *p_result, rlm_ldap_t const *inst, request_t *request, fr_pair_t *check)