svn commit: r125741 - /apr/apr-util/trunk/include/apr_ldap_url.h

[mi...@apache.org]

Author: minfrin
Date: Thu Jan 20 00:51:50 2005
New Revision: 125741

URL: http://svn.apache.org/viewcvs?view=rev&rev=125741
Log:
Add documentation for the LDAP URL functions.

Modified:
   apr/apr-util/trunk/include/apr_ldap_url.h

Modified: apr/apr-util/trunk/include/apr_ldap_url.h
Url: http://svn.apache.org/viewcvs/apr/apr-util/trunk/include/apr_ldap_url.h?view=diff&rev=125741&p1=apr/apr-util/trunk/include/apr_ldap_url.h&r1=125740&p2=apr/apr-util/trunk/include/apr_ldap_url.h&r2=125741
==============================================================================
--- apr/apr-util/trunk/include/apr_ldap_url.h	(original)
+++ apr/apr-util/trunk/include/apr_ldap_url.h	Thu Jan 20 00:51:50 2005
@@ -13,17 +13,25 @@
  * limitations under the License.
  */
 
+/**
+ * @file apr_ldap_url.h
+ * @brief  APR-UTIL LDAP ldap_init() functions
+ */
 #ifndef APR_LDAP_URL_H
 #define APR_LDAP_URL_H
 
+/**
+ * @defgroup APR_Util_LDAP LDAP
+ * @ingroup APR_Util
+ * @{
+ */
+
 #if APR_HAS_LDAP
 
 #include "apu.h"
 #include "apr_pools.h"
 
-/*
- * types for ldap URL handling
- */
+/** Structure to access an exploded LDAP URL */
 typedef struct apr_ldap_url_desc_t {
     struct  apr_ldap_url_desc_t  *lud_next;
     char    *lud_scheme;
@@ -51,26 +59,50 @@
 #define APR_LDAP_URL_ERR_BADEXTS      0x0a    /* bad or missing extensions */
 #endif
 
-/*
- * in url.c
- *
+/**
+ * Is this URL an ldap url? ldap://
+ * @param url The url to test
  */
 APU_DECLARE(int) apr_ldap_is_ldap_url(const char *url);
 
+/**
+ * Is this URL an SSL ldap url? ldaps://
+ * @param url The url to test
+ */
 APU_DECLARE(int) apr_ldap_is_ldaps_url(const char *url);
 
+/**
+ * Is this URL an ldap socket url? ldapi://
+ * @param url The url to test
+ */
 APU_DECLARE(int) apr_ldap_is_ldapi_url(const char *url);
 
+/**
+ * Parse an LDAP URL.
+ * @param pool The pool to use
+ * @param url_in The URL to parse
+ * @param ludpp The structure to return the exploded URL
+ * @param result_err The result structure of the operation
+ */
 APU_DECLARE(int) apr_ldap_url_parse_ext(apr_pool_t *pool,
                                         const char *url_in,
                                         apr_ldap_url_desc_t **ludpp,
                                         apr_ldap_err_t **result_err);
 
+/**
+ * Parse an LDAP URL.
+ * @param pool The pool to use
+ * @param url_in The URL to parse
+ * @param ludpp The structure to return the exploded URL
+ * @param result_err The result structure of the operation
+ */
 APU_DECLARE(int) apr_ldap_url_parse(apr_pool_t *pool,
                                     const char *url_in,
                                     apr_ldap_url_desc_t **ludpp,
                                     apr_ldap_err_t **result_err);
 
 #endif /* APR_HAS_LDAP */
+
+/** @} */
 
 #endif /* APR_LDAP_URL_H */