More minor doxygen fixes
authorArran Cudbard-Bell <a.cudbardb@freeradius.org>
Wed, 22 Oct 2014 03:34:48 +0000 (23:34 -0400)
committerArran Cudbard-Bell <a.cudbardb@freeradius.org>
Thu, 23 Oct 2014 21:47:20 +0000 (17:47 -0400)
33 files changed:
src/include/build.h
src/include/connection.h
src/include/libradius.h
src/include/log.h
src/include/map.h
src/include/md5.h
src/include/modules.h
src/include/radclient.h
src/include/radiusd.h
src/include/soh.h
src/include/tcp.h
src/include/threads.h
src/include/tls-h
src/include/tmpl.h
src/include/token.h
src/lib/dict.c
src/lib/radius.c
src/main/modcall.c
src/main/process.c
src/main/soh.c
src/main/tmpl.c
src/main/valuepair.c
src/main/xlat.c
src/modules/proto_vmps/vqp.h
src/modules/rlm_couchbase/couchbase.c
src/modules/rlm_couchbase/couchbase.h
src/modules/rlm_couchbase/jsonc_missing.c
src/modules/rlm_couchbase/jsonc_missing.h
src/modules/rlm_couchbase/mod.c
src/modules/rlm_couchbase/mod.h
src/modules/rlm_couchbase/rlm_couchbase.c
src/modules/rlm_rest/rest.c
src/modules/rlm_rest/rest.h

index 4c1bf1a..1934023 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * $Id$
  *
  * @brief Source control functions
index e3752d5..316422d 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef FR_CONNECTION_H
 #define FR_CONNECTION_H
-/*
+/**
  * $Id$
  *
  * @file connection.h
index f4bfaa2..5230bc0 100644 (file)
@@ -13,7 +13,7 @@
  *   License along with this library; if not, write to the Free Software
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
-#ifndef LIBRADIUS_H
+#i8fndef LIBRADIUS_H
 #define LIBRADIUS_H
 /*
  * $Id$
index 603535a..c2d2604 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef FR_LOG_H
 #define FR_LOG_H
-/*
+/**
  * $Id$
  *
  * @file log.h
index 7d677eb..d222f2a 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef MAP_H
 #define MAP_H
-/*
+/**
  * $Id$
  *
  * @file map.h
index 0a40a9e..b9e6bda 100644 (file)
@@ -1,4 +1,4 @@
-/*
+/**
  * $Id$
  *
  * @file md5.h
index 3b283d5..1e214ba 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file modules.h
index d1f3047..2a7bb78 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef _RADCLIENT_H
 #define _RADCLIENT_H
-/*
+/**
  * $Id$
  *
  * @file radclient.h
index 1bf15d7..938081a 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef RADIUSD_H
 #define RADIUSD_H
-/*
+/**
  * $Id$
  *
  * @file radiusd.h
index ab32f8c..c1187cc 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef FR_SOH_H
 #define FR_SOH_H
-/*
+/**
  * $Id$
  *
  * @file soh.h
index 24c6a21..cf3f2a8 100644 (file)
@@ -15,7 +15,7 @@
  */
 #ifndef FR_TCP_H
 #define FR_TCP_H
-/*
+/**
  * $Id$
  *
  * @file tcp.h
index 55af56c..4548b7b 100644 (file)
@@ -16,7 +16,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file threads.h
index dba1b9f..0128317 100644 (file)
@@ -17,7 +17,7 @@
 #define FR_TLS_H
 
 #ifdef WITH_TLS
-/*
+/**
  * $Id$
  *
  * @file tls.h
index 34ddc5f..ee37a81 100644 (file)
@@ -58,7 +58,7 @@ typedef struct pair_list {
        struct pair_list        *lastdefault;
 } PAIR_LIST;
 
-/*
+/**
  * $Id$
  *
  * @file map.h
index aa9e0cd..6cbd052 100644 (file)
@@ -16,7 +16,7 @@
 #ifndef FR_TOKEN_H
 #define FR_TOKEN_H
 
-/*
+/**
  * $Id$
  *
  * @file token.h
index e5c6490..ed83207 100644 (file)
@@ -3025,10 +3025,9 @@ DICT_ATTR const *dict_attrbyvalue(unsigned int attr, unsigned int vendor)
 }
 
 
-/**
- * @brief Get an attribute by its numerical value. and data type
+/** Get an attribute by its numerical value and data type
  *
- *     Used only for COMBO_IP
+ * Used only for COMBO_IP
  *
  * @return The attribute, or NULL if not found
  */
@@ -3044,8 +3043,8 @@ DICT_ATTR const *dict_attrbytype(unsigned int attr, unsigned int vendor,
        return fr_hash_table_finddata(attributes_combo, &da);
 }
 
-/**
- * @brief Using a parent and attr/vendor, find a child attr/vendor
+/** Using a parent and attr/vendor, find a child attr/vendor
+ *
  */
 int dict_attr_child(DICT_ATTR const *parent,
                    unsigned int *pattr, unsigned int *pvendor)
index 17744b3..bd7bf29 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file radius.c
@@ -382,7 +382,6 @@ ssize_t rad_recv_header(int sockfd, fr_ipaddr_t *src_ipaddr, uint16_t *src_port,
 
 /** Wrapper for recvfrom, which handles recvfromto, IPv6, and all possible combinations
  *
-
  */
 static ssize_t rad_recvfrom(int sockfd, RADIUS_PACKET *packet, int flags,
                            fr_ipaddr_t *src_ipaddr, uint16_t *src_port,
index c011ca3..4565d03 100644 (file)
@@ -1091,9 +1091,9 @@ next_sibling:
 }
 
 
-/**
- * @brief Call a module, iteratively, with a local stack, rather than
- *     recursively.  What did Paul Graham say about Lisp...?
+/** Call a module, iteratively, with a local stack, rather than recursively
+ *
+ * What did Paul Graham say about Lisp...?
  */
 int modcall(rlm_components_t component, modcallable *c, REQUEST *request)
 {
index e17b595..75f22c8 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file process.c
index 5d3f677..945b295 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file soh.c
@@ -373,7 +373,7 @@ static char const* healthclass2str(uint8_t hc) {
        return NULL;
 }
 
-/**  Parse the MS-SOH response in data and update sohvp
+/** Parse the MS-SOH response in data and update sohvp
  *
  * Note that sohvp might still have been updated in event of a failure.
  *
index 157b30f..6872b68 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief VALUE_PAIR template functions
index 6bb0de9..6c1079b 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Valuepair functions that are radiusd-specific and as such do not
index 5ea0aac..193e3f3 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @file xlat.c
index bbd2cac..2e3f02f 100644 (file)
@@ -16,7 +16,7 @@
 #ifndef FR_VQP_H
 #define FR_VQP_H
 
-/*
+/**
  * $Id$
  *
  * @file vqp.h
index e631b19..b0e0466 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Wrapper functions around the libcouchbase Couchbase client driver.
index 8ac5da6..f1c0109 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Couchbase wrapper function prototypes and datatypes.
index 039ccac..16f7191 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Workarounds for missing functions in older json-c libraries.
index 84ff230..9271c89 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Function prototypes for missing functions in older json-c libraries.
index 0d91749..4078532 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Utillity functions used in the module.
index bbc63f8..f21067b 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Function prototypes and datatypes used in the module.
index a8c781a..3e6d400 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Integrate FreeRADIUS with the Couchbase document database.
@@ -265,7 +265,7 @@ static rlm_rcode_t CC_HINT(nonnull) mod_authorize(void *instance, REQUEST *reque
        return RLM_MODULE_OK;
 }
 
-/**  Write accounting data to Couchbase documents
+/** Write accounting data to Couchbase documents
  *
  * Handle accounting requests and store the associated data into JSON documents
  * in couchbase mapping attribute names to JSON element names per the module configuration.
index bffb740..bf4f845 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Functions and datatypes for the REST (HTTP) transport.
index 8f12b13..74c7729 100644 (file)
@@ -14,7 +14,7 @@
  *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */
 
-/*
+/**
  * $Id$
  *
  * @brief Function prototypes and datatypes for the REST (HTTP) transport.