From: Arran Cudbard-Bell Date: Fri, 11 Jan 2013 23:17:53 +0000 (+0000) Subject: Move license declarations outside of file descriptions X-Git-Tag: release_3_0_0_beta1~1320 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=6474a01c17bd3fece4129aab242ac0f0e7b9e11f;p=thirdparty%2Ffreeradius-server.git Move license declarations outside of file descriptions --- diff --git a/src/include/connection.h b/src/include/connection.h index c6b7e5862c7..b72a2e99c69 100644 --- a/src/include/connection.h +++ b/src/include/connection.h @@ -1,12 +1,4 @@ -#ifndef FR_CONNECTION_H -#define FR_CONNECTION_H -/** - * @file connection.h - * @brief Structures, prototypes and global variables - * for server connection pools. - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,11 +12,17 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_CONNECTION_H +#define FR_CONNECTION_H +/** + * @file connection.h + * @brief Structures, prototypes and global variables for server connection pools. * - * Copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project - * + * @version $Id$ + * @copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project */ - + #include RCSIDH(connection_h, "$Id$") diff --git a/src/include/libradius.h b/src/include/libradius.h index 8fe4bea7d00..c84ff64fc9f 100644 --- a/src/include/libradius.h +++ b/src/include/libradius.h @@ -1,13 +1,4 @@ -#ifndef LIBRADIUS_H -#define LIBRADIUS_H - /* - * @file libradius.h - * @brief Structures and prototypes - * for the radius library. - * - * Version: $Id$ - * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either @@ -21,8 +12,15 @@ * You should have received a copy of the GNU Lesser General Public * 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 +#define LIBRADIUS_H +/* + * @file libradius.h + * @brief Structures and prototypes for the radius library. * - * Copyright 1999,2000,2001,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project + * @version $Id$ + * @copyright 1999,2000,2001,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project */ #include diff --git a/src/include/md5.h b/src/include/md5.h index 20c35709641..380cbc9480e 100644 --- a/src/include/md5.h +++ b/src/include/md5.h @@ -2,9 +2,8 @@ * @file md5.h * @brief Structures and prototypes for md5. * - * Version: $Id$ - * License: LGPL, but largely derived from a public domain source. - * + * @version $Id$ + * @license LGPL, but largely derived from a public domain source. */ #ifndef _FR_MD5_H diff --git a/src/include/modules.h b/src/include/modules.h index bca4fa499d7..a9a5daae2bc 100644 --- a/src/include/modules.h +++ b/src/include/modules.h @@ -1,7 +1,9 @@ /* * @file modules.h * @brief Interface to the RADIUS module system. + * * @version $Id$ + * @copyright 2013 The FreeRADIUS server project */ #ifndef RADIUS_MODULES_H @@ -95,8 +97,8 @@ extern const section_type_value_t section_type_value[]; * Is called when the module is listed in a particular section of a virtual * server, and the request has reached the module call. * - * @param [in] instance created in instantiated, holds module config. - * @param [in,out] request being processed. + * @param[in] instance created in instantiated, holds module config. + * @param[in,out] request being processed. * @return the appropriate rcode. */ typedef rlm_rcode_t (*packetmethod)(void *instance, REQUEST *request); @@ -107,8 +109,8 @@ typedef rlm_rcode_t (*packetmethod)(void *instance, REQUEST *request); * spawned. Modules that require separate thread contexts should use the * connection pool API. * - * @param [in] mod_cs Module instance's configuration section. - * @param [out] instance Module instance's configuration structure, should be + * @param[in] mod_cs Module instance's configuration section. + * @param[out] instance Module instance's configuration structure, should be * alloced by by callback and freed by detach. * @return -1 if instantiation failed, else 0. */ @@ -122,7 +124,7 @@ typedef int (*instantiate_t)(CONF_SECTION *mod_cs, void **instance); * Detach should close all handles associated with the module instance, and * free any memory allocated during instantiate. * - * @param [in] instance to free. + * @param[in] instance to free. * @return -1 if detach failed, else 0. */ typedef int (*detach_t)(void *instance); diff --git a/src/include/radiusd.h b/src/include/radiusd.h index c0ec50ff7c4..1b8b2c27945 100644 --- a/src/include/radiusd.h +++ b/src/include/radiusd.h @@ -1,12 +1,4 @@ -#ifndef RADIUSD_H -#define RADIUSD_H -/** - * @file radiusd.h - * @brief Structures, prototypes and global variables - * for the FreeRADIUS server. - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,9 +12,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef RADIUSD_H +#define RADIUSD_H +/* + * @file radiusd.h + * @brief Structures, prototypes and global variables for the FreeRADIUS server. * - * Copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project - * + * @version $Id$ + * @copyright 1999,2000,2002,2003,2004,2005,2006,2007,2008 The FreeRADIUS server project */ #include diff --git a/src/include/soh.h b/src/include/soh.h index 594bce10b55..db3cc83efec 100644 --- a/src/include/soh.h +++ b/src/include/soh.h @@ -1,12 +1,4 @@ -#ifndef FR_SOH_H -#define FR_SOH_H - /* - * @file soh.h - * @brief Microsoft SoH support - * - * Version: $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,8 +12,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_SOH_H +#define FR_SOH_H +/* + * @file soh.h + * @brief Microsoft SoH support * - * Copyright 2010 Phil Mayers + * @version $Id$ + * @copyright 2010 Phil Mayers */ #include diff --git a/src/include/tcp.h b/src/include/tcp.h index 4e3abc8c792..cb86062ac4d 100644 --- a/src/include/tcp.h +++ b/src/include/tcp.h @@ -1,12 +1,4 @@ -#ifndef FR_TCP_H -#define FR_TCP_H - /* - * @file tcp.h - * @brief RADIUS over TCP - * - * Version: $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,8 +12,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_TCP_H +#define FR_TCP_H +/* + * @file tcp.h + * @brief RADIUS over TCP * - * Copyright (C) 2009 Dante http://dante.net + * @version $Id$ + * @copyright 2009 Dante http://dante.net */ #include diff --git a/src/include/tls-h b/src/include/tls-h index 208031444ac..d855c6a5a94 100644 --- a/src/include/tls-h +++ b/src/include/tls-h @@ -1,13 +1,4 @@ -#ifndef FR_TLS_H -#define FR_TLS_H - -#ifdef WITH_TLS - -/* - * @file tls.h - * @brief Structures and prototypes for TLS wrappers - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -21,8 +12,17 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_TLS_H +#define FR_TLS_H + +#ifdef WITH_TLS +/* + * @file tls.h + * @brief Structures and prototypes for TLS wrappers * - * Copyright 2010 Network RADIUS SARL + * @version $Id$ + * @copyright 2010 Network RADIUS SARL */ #include diff --git a/src/include/token.h b/src/include/token.h index f7d81f4a3de..c3bf7753d30 100644 --- a/src/include/token.h +++ b/src/include/token.h @@ -1,12 +1,4 @@ -#ifndef FR_TOKEN_H -#define FR_TOKEN_H - /* - * @file token.h - * @brief Tokenisation code and constants - * - * $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,8 +12,16 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_TOKEN_H +#define FR_TOKEN_H + +/* + * @file token.h + * @brief Tokenisation code and constants. * - * Copyright 2001,2006 The FreeRADIUS server project + * @version $Id$ + * @copyright 2001,2006 The FreeRADIUS server project */ #include diff --git a/src/include/udpfromto.h b/src/include/udpfromto.h index 87ccacf63a3..3e7ddb8395a 100644 --- a/src/include/udpfromto.h +++ b/src/include/udpfromto.h @@ -3,8 +3,8 @@ /* * @file udpfromto.h * - * Version: $Id$ - * + * @version $Id$ + * @copyright 2013 The FreeRADIUS server project */ #include diff --git a/src/include/vmps.h b/src/include/vmps.h index b94c1fb5a45..fb7bd1b2c51 100644 --- a/src/include/vmps.h +++ b/src/include/vmps.h @@ -4,8 +4,8 @@ * @file vmps.h * @brief Routines to handle VMPS sockets. * - * Version: $Id$ - * + * @version $Id$ + * @copyright 2013 The FreeRADIUS server project */ #include diff --git a/src/include/vqp.h b/src/include/vqp.h index 408456447e0..6c598ecf60b 100644 --- a/src/include/vqp.h +++ b/src/include/vqp.h @@ -1,12 +1,4 @@ -#ifndef FR_VQP_H -#define FR_VQP_H - /* - * @file vqp.h - * @brief Structures and prototypes for Cisco's VLAN Query Protocol - * - * Version: $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,9 +12,17 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ +#ifndef FR_VQP_H +#define FR_VQP_H + +/* + * @file vqp.h + * @brief Structures and prototypes for Cisco's VLAN Query Protocol * - * Copyright 2007 The FreeRADIUS server project - * Copyright 2007 Alan DeKok + * @version $Id$ + * @copyright 2007 The FreeRADIUS server project + * @copyright 2007 Alan DeKok */ #include diff --git a/src/lib/radius.c b/src/lib/radius.c index 3c32ff647fc..5fb1b8c4cd5 100644 --- a/src/lib/radius.c +++ b/src/lib/radius.c @@ -1,9 +1,4 @@ -/** - * @file radius.c - * @brief Functions to send/receive radius packets. - * - * Version: $Id$ - * +/* * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either @@ -17,8 +12,14 @@ * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @file radius.c + * @brief Functions to send/receive radius packets. * - * Copyright 2000-2003,2006 The FreeRADIUS server project + * @version $Id$ + * @copyright 2000-2003,2006 The FreeRADIUS server project */ #include diff --git a/src/main/connection.c b/src/main/connection.c index 19d1969257e..56c7736b82b 100644 --- a/src/main/connection.c +++ b/src/main/connection.c @@ -175,8 +175,8 @@ static const CONF_PARSER connection_config[] = { * * @note Must be called with the mutex held. * - * @param [in,out] pool to modify. - * @param [in] this Connection to delete. + * @param[in,out] pool to modify. + * @param[in] this Connection to delete. */ static void fr_connection_unlink(fr_connection_pool_t *pool, fr_connection_t *this) @@ -203,8 +203,8 @@ static void fr_connection_unlink(fr_connection_pool_t *pool, * * @note Must be called with the mutex held. * - * @param [in,out] pool to modify. - * @param [in] this Connection to add. + * @param[in,out] pool to modify. + * @param[in] this Connection to add. */ static void fr_connection_link(fr_connection_pool_t *pool, fr_connection_t *this) @@ -235,8 +235,8 @@ static void fr_connection_link(fr_connection_pool_t *pool, * @note Will call the 'open' trigger. * @note Must be called with the mutex free. * - * @param [in] pool - * @param [in] now Current time. + * @param[in] pool + * @param[in] now Current time. * @return the new connection struct or NULL on error. */ static fr_connection_t *fr_connection_spawn(fr_connection_pool_t *pool, @@ -352,8 +352,8 @@ static fr_connection_t *fr_connection_spawn(fr_connection_pool_t *pool, * * @note Will call the 'open' trigger. * - * @param [in,out] pool to add connection to. - * @param [in] conn to add. + * @param[in,out] pool to add connection to. + * @param[in] conn to add. * @return 0 if the connection wasn't added else 1. */ int fr_connection_add(fr_connection_pool_t *pool, void *conn) @@ -409,8 +409,8 @@ int fr_connection_add(fr_connection_pool_t *pool, void *conn) * @note Will call the 'close' trigger. * @note Must be called with the mutex held. * - * @param [in,out] pool to modify. - * @param [in,out] this Connection to delete. + * @param[in,out] pool to modify. + * @param[in,out] this Connection to delete. */ static void fr_connection_close(fr_connection_pool_t *pool, @@ -436,8 +436,8 @@ static void fr_connection_close(fr_connection_pool_t *pool, * is not found, so will usually return will mutex held. * @note Must be called with the mutex free. * - * @param [in] pool to search in. - * @param [in] conn handle to search for. + * @param[in] pool to search in. + * @param[in] conn handle to search for. * @return the connection containing the specified handle, or NULL if non is * found. */ @@ -469,8 +469,8 @@ static fr_connection_t *fr_connection_find(fr_connection_pool_t *pool, void *con * * @note Must be called with the mutex free. * - * @param [in,out] pool Connection pool to modify. - * @param [in] conn to delete. + * @param[in,out] pool Connection pool to modify. + * @param[in] conn to delete. * @return 0 if the connection could not be found, else 1. */ int fr_connection_del(fr_connection_pool_t *pool, void *conn) @@ -507,7 +507,7 @@ int fr_connection_del(fr_connection_pool_t *pool, void *conn) * @note Will call the 'stop' trigger. * @note Must be called with the mutex free. * - * @param [in,out] pool to delete. + * @param[in,out] pool to delete. */ void fr_connection_pool_delete(fr_connection_pool_t *pool) { @@ -556,11 +556,11 @@ void fr_connection_pool_delete(fr_connection_pool_t *pool) * * @note Will call the 'start' trigger. * - * @param [in] parent configuration section containing a 'pool' subsection. - * @param [in] ctx pointer to pass to callbacks. - * @param [in] c Callback to create new connections. - * @param [in] a Callback to check the status of connections. - * @param [in] d Callback to delete connections. + * @param[in] parent configuration section containing a 'pool' subsection. + * @param[in] ctx pointer to pass to callbacks. + * @param[in] c Callback to create new connections. + * @param[in] a Callback to check the status of connections. + * @param[in] d Callback to delete connections. * @return A new connection pool or NULL on error. */ fr_connection_pool_t *fr_connection_pool_init(CONF_SECTION *parent, @@ -674,9 +674,9 @@ fr_connection_pool_t *fr_connection_pool_init(CONF_SECTION *parent, * @note Will only close connections not in use. * @note Must be called with the mutex held. * - * @param [in,out] pool - * @param [in,out] this Connection to manage. - * @param [in] now Current time. + * @param[in,out] pool + * @param[in,out] this Connection to manage. + * @param[in] now Current time. * @return 0 if the connection was closed, otherwise 1. */ static int fr_connection_manage(fr_connection_pool_t *pool, @@ -737,7 +737,7 @@ static int fr_connection_manage(fr_connection_pool_t *pool, * @note Must be called with the mutex held, will release mutex before * returning. * - * @param [in,out] pool to manage. + * @param[in,out] pool to manage. * @return 1 */ static int fr_connection_pool_check(fr_connection_pool_t *pool) @@ -819,8 +819,8 @@ static int fr_connection_pool_check(fr_connection_pool_t *pool) * * @see fr_connection_manage * @see fr_connection_pool_check - * @param [in,out] pool to manage. - * @param [in,out] conn to check. + * @param[in,out] pool to manage. + * @param[in,out] conn to check. * @return 0 if the connection was closed, else 1. */ int fr_connection_check(fr_connection_pool_t *pool, void *conn) @@ -862,7 +862,7 @@ int fr_connection_check(fr_connection_pool_t *pool, void *conn) * using the connection. * * @see fr_connection_release - * @param [in,out] pool to reserve the connection from. + * @param[in,out] pool to reserve the connection from. * @return a pointer to the connection handle, or NULL on error. */ void *fr_connection_get(fr_connection_pool_t *pool) @@ -926,8 +926,8 @@ do_return: * connections. * * @see fr_connection_get - * @param [in,out] pool to release the connection in. - * @param [in,out] conn to release. + * @param[in,out] pool to release the connection in. + * @param[in,out] conn to release. */ void fr_connection_release(fr_connection_pool_t *pool, void *conn) { @@ -982,8 +982,8 @@ void fr_connection_release(fr_connection_pool_t *pool, void *conn) * the old handle in any other operations, as its memory will have been freed. * * @see fr_connection_get - * @param [in,out] pool to reconnect the connection in. - * @param [in,out] conn to reconnect. + * @param[in,out] pool to reconnect the connection in. + * @param[in,out] conn to reconnect. * @return ew connection handle if successful else NULL. */ void *fr_connection_reconnect(fr_connection_pool_t *pool, void *conn) diff --git a/src/main/exec.c b/src/main/exec.c index d20036b081b..bbcb6f24b30 100644 --- a/src/main/exec.c +++ b/src/main/exec.c @@ -1,9 +1,4 @@ /* - * @file exec.c - * @brief Execute external programs. - * - * Version: $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,8 +12,14 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @file exec.c + * @brief Execute external programs. * - * Copyright 2000-2004,2006 The FreeRADIUS server project + * @version $Id$ + * @copyright 2000-2004,2006 The FreeRADIUS server project */ #include diff --git a/src/main/process.c b/src/main/process.c index 461a41be05a..49c5ec19fec 100644 --- a/src/main/process.c +++ b/src/main/process.c @@ -1,9 +1,4 @@ -/** - * @file process.c - * @brief Handle requests - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,9 +12,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/** + * @file process.c + * @brief Defines the state machines that control how requests are processed. * - * Copyright 2012 The FreeRADIUS server project - * Copyright 2012 Alan DeKok + * @version $Id$ + * @copyright 2012 The FreeRADIUS server project + * @copyright 2012 Alan DeKok */ #include diff --git a/src/main/soh.c b/src/main/soh.c index 3c034827727..293f35c9461 100644 --- a/src/main/soh.c +++ b/src/main/soh.c @@ -1,9 +1,4 @@ -/** - * @file soh.c - * @brief Implements the MS-SOH parsing code. This is called from rlm_eap_peap - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,8 +12,14 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @file soh.c + * @brief Implements the MS-SOH parsing code. This is called from rlm_eap_peap * - * Copyright 2010 Phil Mayers + * @version $Id$ + * @copyright 2010 Phil Mayers */ #include diff --git a/src/main/valuepair.c b/src/main/valuepair.c index f495866b7ce..28bb95bc7cc 100644 --- a/src/main/valuepair.c +++ b/src/main/valuepair.c @@ -1,12 +1,4 @@ -/** Valuepair functions that are radiusd-specific and as such do not belong in - * the library. - * - * @file main/valuepair.c - * - * @ingroup AVP - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -20,9 +12,18 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @brief Valuepair functions that are radiusd-specific and as such do not + * belong in the library. + * @file main/valuepair.c + * + * @ingroup AVP * - * Copyright 2000,2006 The FreeRADIUS server project - * Copyright 2000 Alan DeKok + * @version $Id$ + * @copyright 2000,2006 The FreeRADIUS server project + * @copyright 2000 Alan DeKok */ #include diff --git a/src/main/xlat.c b/src/main/xlat.c index c0638505ceb..2b3645f4694 100644 --- a/src/main/xlat.c +++ b/src/main/xlat.c @@ -1,9 +1,4 @@ /* - * @file xlat.c - * @brief String expansion ("translation"). Implements %Attribute -> value - * - * Version: $Id$ - * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,9 +12,15 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @file xlat.c + * @brief String expansion ("translation"). Implements %Attribute -> value * - * Copyright 2000,2006 The FreeRADIUS server project - * Copyright 2000 Alan DeKok + * @version $Id$ + * @copyright 2000,2006 The FreeRADIUS server project + * @copyright 2000 Alan DeKok */ #include @@ -907,9 +908,9 @@ int xlat_register(const char *module, RAD_XLAT_FUNC func, void *instance) * We can only have one function to call per name, so the passing of "func" * here is extraneous. * - * @param [in] module xlat to unregister. - * @param [in] func - * @param [in] instance + * @param[in] module xlat to unregister. + * @param[in] func + * @param[in] instance */ void xlat_unregister(const char *module, RAD_XLAT_FUNC func, void *instance) { @@ -949,12 +950,12 @@ void xlat_free(void) * * Calls radius_xlat() to do most of the work. * - * @param [in] from string to expand. - * @param [in,out] to buffer for output. - * @param [in] freespace remaining in output buffer. - * @param [in] request Current server request. - * @param [in] func Optional function to escape output; passed to radius_xlat(). - * @param [in] funcarg pointer to pass to escape function. + * @param[in] from string to expand. + * @param[in,out] to buffer for output. + * @param[in] freespace remaining in output buffer. + * @param[in] request Current server request. + * @param[in] func Optional function to escape output; passed to radius_xlat(). + * @param[in] funcarg pointer to pass to escape function. * @return 0 on success, -1 on failure. */ static int decode_attribute(const char **from, char **to, int freespace, @@ -1207,12 +1208,12 @@ done: * * See 'doc/variables.txt' for more information. * - * @param [out] out output buffer. - * @param [in] outlen size of output buffer. - * @param [in] fmt string to expand. - * @param [in] request current request. - * @param [in] func function to escape final value e.g. SQL quoting. - * @param [in] funcarg pointer to pass to escape function. + * @param[out] out output buffer. + * @param[in] outlen size of output buffer. + * @param[in] fmt string to expand. + * @param[in] request current request. + * @param[in] func function to escape final value e.g. SQL quoting. + * @param[in] funcarg pointer to pass to escape function. * @return length of string written @bug should really have -1 for failure */ size_t radius_xlat(char *out, int outlen, const char *fmt, diff --git a/src/modules/rlm_rest/rest.c b/src/modules/rlm_rest/rest.c index 0c63fa8141f..1d6ac4bf3ed 100644 --- a/src/modules/rlm_rest/rest.c +++ b/src/modules/rlm_rest/rest.c @@ -1,9 +1,4 @@ -/** Functions and datatypes for the REST (HTTP) transport. - * - * @file rest.c - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,8 +12,14 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/** + * @brief Functions and datatypes for the REST (HTTP) transport. + * @file rest.c * - * Copyright 2012 Arran Cudbard-Bell + * @version $Id$ + * @copyright 2012-2013 Arran Cudbard-Bell */ #include @@ -1160,7 +1161,7 @@ static int rest_decode_post(rlm_rest_t *instance, * @param[in] instance configuration data. * @param[in] section configuration data. * @param[in] request Current request. - * @param[in] attribute name without qualifiers. + * @param[in] da Attribute to create. * @param[in] flags containing the operator other flags controlling value * expansion. * @param[in] leaf object containing the VALUE_PAIR value. @@ -1490,14 +1491,15 @@ static VALUE_PAIR *json_pairmake(rlm_rest_t *instance, * * @param[in] instance configuration data. * @param[in] section configuration data. - * @param[in] request Current request. + * @param[in,out] request Current request. + * @param[in] handle REST handle. * @param[in] raw buffer containing JSON data. * @param[in] rawlen Length of data in raw buffer. * @return the number of VALUE_PAIRs processed or -1 on unrecoverable error. */ static int rest_decode_json(rlm_rest_t *instance, UNUSED rlm_rest_section_t *section, - UNUSED REQUEST *request, UNUSED void *handle, + REQUEST *request, UNUSED void *handle, char *raw, UNUSED size_t rawlen) { const char *p = raw; @@ -1606,7 +1608,7 @@ static size_t rest_write_header(void *ptr, size_t size, size_t nmemb, ctx->code = atoi(p); /* - * Process reason_phrase (if present). + * Process reason_phrase (if present). */ if (p[3] == ' ') { p += 4; diff --git a/src/modules/rlm_rest/rest.h b/src/modules/rlm_rest/rest.h index 95f0932be63..f74c11bb076 100644 --- a/src/modules/rlm_rest/rest.h +++ b/src/modules/rlm_rest/rest.h @@ -1,9 +1,4 @@ -/** Function prototypes datatypes for the REST (HTTP) transport. - * - * @file rest.h - * - * Version: $Id$ - * +/* * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or @@ -17,8 +12,14 @@ * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA + */ + +/* + * @brief Function prototypes datatypes for the REST (HTTP) transport. + * @file rest.h * - * Copyright 2012 Arran Cudbard-Bell + * @version $Id$ + * @copyright 2012-2013 Arran Cudbard-Bell */ #include #include