From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Sun, 22 May 2016 02:25:25 +0000 (-0400)
Subject: Document arguments
X-Git-Tag: branch_3_1_x~343
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b11d71b946d7ec9049f6ffca16ebd336d7250779;p=thirdparty%2Ffreeradius-server.git

Document arguments
---

diff --git a/src/modules/rlm_eap/types/rlm_eap_sim/rlm_eap_sim.c b/src/modules/rlm_eap/types/rlm_eap_sim/rlm_eap_sim.c
index ec33c78f9be..33285e5cf88 100644
--- a/src/modules/rlm_eap/types/rlm_eap_sim/rlm_eap_sim.c
+++ b/src/modules/rlm_eap/types/rlm_eap_sim/rlm_eap_sim.c
@@ -364,6 +364,7 @@ static int eap_sim_vector_from_umts(eap_session_t *eap_session, VALUE_PAIR *vps,
  *
  * @param eap_session	The current eap_session.
  * @param vps		List to hunt for triplets in.
+ * @param idx		To write EAP-SIM triplets to.
  * @param ess		EAP session state.
  * @param src		Forces triplets to be retrieved from a particular src
  *			and ensures if multiple triplets are being retrieved
diff --git a/src/modules/rlm_ldap/ldap.c b/src/modules/rlm_ldap/ldap.c
index 48506573d7d..2a40741824a 100644
--- a/src/modules/rlm_ldap/ldap.c
+++ b/src/modules/rlm_ldap/ldap.c
@@ -748,6 +748,7 @@ process_error:
  * @param[in] password		of the user, may be NULL if no password is specified.
  * @param[in] sasl		mechanism to use for bind, and additional parameters.
  * @param[in] retry		whether we're rebinding an existing connection.
+ * @param[in] timeout		Maximum time bind is allowed to take.
  * @param[in] serverctrls	Only used for SASL binds.  May be NULL.
  * @param[in] clientctrls	Search controls for sasl_bind.
  *				Only used for SASL binds. May be NULL.
diff --git a/src/modules/rlm_ldap/sasl.c b/src/modules/rlm_ldap/sasl.c
index a36121bf656..82fb9305849 100644
--- a/src/modules/rlm_ldap/sasl.c
+++ b/src/modules/rlm_ldap/sasl.c
@@ -91,15 +91,17 @@ static int _sasl_interact(UNUSED LDAP *handle, UNUSED unsigned flags, void *ctx,
 /** Initiate an LDAP interactive bind
  *
  * @param[in] inst rlm_ldap configuration.
- * @param[in] request Current request, this may be NULL, in which case all debug logging is done with radlog.
- * @param[in] conn to use. May change as this function calls functions which auto re-connect.
- * @param[in] identity of the user.
- * @param[in] password of the user.
- * @param[in] sasl mechanism to use for bind, and additional parameters.
- * @param[in] serverctrls Search controls to pass to the server.  May be NULL.
- * @param[in] clientctrls Search controls for ldap_sasl_interactive.  May be NULL.
- * @param[out] error message resulting from bind.
- * @param[out] extra information about the error.
+ * @param[in] request		Current request, this may be NULL.
+ * @param[in] conn		to use. May change as this function calls functions
+ *				which auto re-connect.
+ * @param[in] identity		of the user.
+ * @param[in] password		of the user.
+ * @param[in] sasl		mechanism to use for bind, and additional parameters.
+ * @param[in] serverctrls	Search controls to pass to the server.  May be NULL.
+ * @param[in] clientctrls	Search controls for ldap_sasl_interactive.  May be NULL.
+ * @param[in] timeout		Maximum time bind is allowed to take.
+ * @param[out] error		message resulting from bind.
+ * @param[out] extra		information about the error.
  * @return One of the LDAP_PROC_* (#ldap_rcode_t) values.
  */
 ldap_rcode_t rlm_ldap_sasl_interactive(rlm_ldap_t const *inst, REQUEST *request,