From: Arran Cudbard-Bell <a.cudbardb@freeradius.org>
Date: Wed, 26 Apr 2017 01:29:17 +0000 (-0400)
Subject: Doxygen
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5948fd3470ac502da64d1c023c3ecbb71b289757;p=thirdparty%2Ffreeradius-server.git

Doxygen
---

diff --git a/src/lib/ldap/map.c b/src/lib/ldap/map.c
index 1913697def6..8d056b02655 100644
--- a/src/lib/ldap/map.c
+++ b/src/lib/ldap/map.c
@@ -16,7 +16,7 @@
 
 /**
  * $Id$
- * @file attrmap.c
+ * @file src/lib/ldap/map.c
  * @brief Functions for mapping between LDAP and FreeRADIUS attributes.
  *
  * @author Arran Cudbard-Bell <a.cudbardb@freeradius.org>
diff --git a/src/modules/proto_ldap_sync/proto_ldap_sync.c b/src/modules/proto_ldap_sync/proto_ldap_sync.c
index 5bbf302f3f0..684c58fba40 100644
--- a/src/modules/proto_ldap_sync/proto_ldap_sync.c
+++ b/src/modules/proto_ldap_sync/proto_ldap_sync.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file proto_ldap_conn.c
+ * @file src/modules/proto_ldap_sync/proto_ldap_sync.c
  *
  * @brief Perform persistent searches against LDAP directories.
  *
@@ -687,6 +687,8 @@ static int _proto_ldap_cookie_store(UNUSED ldap_handle_t *conn, sync_config_t co
  * @param[in] phase	Refresh phase the sync is currently in.
  * @param[in] uuid	of the entry.
  * @param[in] msg	containing the entry.
+ * @param[in] state	The type of modification we need to perform to our
+ *			representation of the entry.
  * @param[in] user_ctx	The listener.
  * @return
  *	- 0 on success.
@@ -779,7 +781,9 @@ static RADCLIENT *proto_ldap_fake_client_alloc(proto_ldap_inst_t *inst)
  * FIXME: This should not be synchronous, but integrating it into the event loop
  *	before the server has started processing requests makes my head hurt.
  *
+ * @param[in] ctx	to allocate cookie buffer in.
  * @param[out] cookie	Where to write the cookie we loaded.
+ * @param[in] listen	structure encapsulating the LDAP
  * @param[in] config	of the sync we're loading the cookie for.
  * @return
  *	- -1 on failure.
@@ -871,6 +875,11 @@ finish:
  *	previous LDAP entries being processed, so we may miss updates in some
  *	circumstances.  This needs to be fixed, but is waiting on v4.0.0
  *	re-architecture.
+ *
+ * @param[in] listen	encapsulating the libldap socket.
+ * @return
+ *	- 1 on success.
+ *	- 0 on failure.
  */
 static int proto_ldap_socket_recv(rad_listen_t *listen)
 {
@@ -929,7 +938,8 @@ static int proto_ldap_socket_recv(rad_listen_t *listen)
  *
  * @note This is performed synchronously.
  *
- * @param[in] listen	encapsulating the libldap socket.
+ * @param[in] cs	specifying the listener configuration.
+ * @param[in] listen	structure encapsulating the libldap socket.
  * @return
  *	- 0 on success.
  *	- -1 on error.
@@ -1048,6 +1058,11 @@ static int proto_ldap_socket_open(UNUSED CONF_SECTION *cs, rad_listen_t *listen)
 
 /** Parse socket configuration
  *
+ * @param[in] cs	specifying the listener configuration.
+ * @param[in] listen	structure encapsulating the libldap socket.
+ * @return
+ *	- 0 on success.
+ *	- -1 on error.
  */
 static int proto_ldap_socket_parse(CONF_SECTION *cs, rad_listen_t *listen)
 {
diff --git a/src/modules/proto_ldap_sync/sync.c b/src/modules/proto_ldap_sync/sync.c
index 25b49077253..8e08c70a9e5 100644
--- a/src/modules/proto_ldap_sync/sync.c
+++ b/src/modules/proto_ldap_sync/sync.c
@@ -15,7 +15,7 @@
  */
 
 /**
- * @file sync/sync.c
+ * @file src/modules/proto_ldap_sync/sync.c
  *
  * @brief Synchronisation controls for interacting with directories impliementing
  *	"LDAP Content Sync Operation" (RFC 4533).
diff --git a/src/modules/proto_ldap_sync/sync.h b/src/modules/proto_ldap_sync/sync.h
index 93053431b99..11b81e9248e 100644
--- a/src/modules/proto_ldap_sync/sync.h
+++ b/src/modules/proto_ldap_sync/sync.h
@@ -15,10 +15,10 @@
  */
 
 /**
- * @file proto_ldap_sync/proto_ldap_sync.h
+ * @file src/modules/proto_ldap_sync/sync.h
  *
- * @brief Perform persistent searches against LDAP directories,
- *	to perform actions if their contents change.
+ * @brief Perform persistent searches against LDAP directories, to perform actions
+ *	  if their contents change.
  *
  * @author Arran Cudbard-Bell
  *