[sr-dev] git:master: doxygen documentation fixes
Henning Westerholt
henning.westerholt at 1und1.de
Thu Jul 28 00:22:26 CEST 2011
Module: sip-router
Branch: master
Commit: 7af697744bd9922ec8e46e1c07e91f591bb60306
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7af697744bd9922ec8e46e1c07e91f591bb60306
Author: Henning Westerholt <henning.westerholt at 1und1.de>
Committer: Henning Westerholt <henning.westerholt at 1und1.de>
Date: Thu Jul 28 00:22:09 2011 +0200
doxygen documentation fixes
---
dprint.h | 4 +---
dst_blacklist.h | 13 +++++--------
mod_fix.c | 11 +++--------
modules/tls/tls_bio.c | 3 ---
modules/tls/tls_bio.h | 5 ++---
modules_k/presence/subscribe.h | 3 ---
modules_k/tmx/t_mi.h | 3 ---
parser/parse_allow.c | 7 ++-----
parser/parse_allow.h | 7 ++++---
parser/parse_param.c | 15 +++++----------
parser/parse_param.h | 7 ++-----
rvalue.h | 4 ++--
12 files changed, 26 insertions(+), 56 deletions(-)
diff --git a/dprint.h b/dprint.h
index 31ba4a2..a9fda8c 100644
--- a/dprint.h
+++ b/dprint.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2001-2003 FhG Fokus
*
* This file is part of ser, a free SIP server.
@@ -103,7 +101,7 @@
(log_level_info[(level) - (L_ALERT)].syslog_level)
-/** @brief my_pid(), process_no are from pt.h but we cannot #include it here
+/** @brief my_pid(), process_no are from pt.h but we cannot \#include it here
because of circular dependencies */
extern int process_no;
extern int my_pid();
diff --git a/dst_blacklist.h b/dst_blacklist.h
index a648b5d..69d83b0 100644
--- a/dst_blacklist.h
+++ b/dst_blacklist.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2006 iptelorg GmbH
*
* This file is part of ser, a free SIP server.
@@ -94,7 +92,7 @@ void destroy_dst_blacklist();
/** force add to the blacklist.
- * like @function dst_blacklist_add_to, but no ignore mask or
+ * like function dst_blacklist_add_to, but no ignore mask or
* blacklist enabled checks are made.
* @see dst_blacklist_add_to for the parameters and return value.
*/
@@ -102,7 +100,7 @@ int dst_blacklist_force_add_to(unsigned char err_flags, struct dest_info* si,
struct sip_msg* msg, ticks_t timeout);
/** force add to the blacklist, long version.
- * like @function dst_blacklist_su_to, but no ignore mask or
+ * like function dst_blacklist_su_to, but no ignore mask or
* blacklist enabled checks are made.
* @see dst_blacklist_su_to for the parameters and return value.
*/
@@ -127,13 +125,12 @@ int dst_blacklist_force_su_to( unsigned char err_flags,
/** checks if blacklist should be used, long version.
- * @param err_flags - blacklist reason
+ * @param err_flags - blacklist reason
* @param snd_flags - snd_flags pointer, can be 0.
* @param proto - protocol, can be 0 (PROTO_NONE).
- * @param si - sockaddr_union pointer, can be 0.
+ * @param su - sockaddr_union pointer, can be 0.
* @return 1 if blacklist is enabled (core_cfg) and the event/error
- * is not in the ignore list.
- * 0 otherwise
+ * is not in the ignore list. 0 otherwise
*/
#define should_blacklist_su(err_flags, snd_flags, proto, su) \
(cfg_get(core, core_cfg, use_dst_blacklist) && \
diff --git a/mod_fix.c b/mod_fix.c
index 8ea5211..df0ca54 100644
--- a/mod_fix.c
+++ b/mod_fix.c
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2008 iptelorg GmbH
*
* Permission to use, copy, modify, and distribute this software for any
@@ -15,10 +13,7 @@
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
-/**
- * @file mod_fix.c
- * @brief kamailio compatible fixups
- */
+
/*
* History:
* --------
@@ -27,7 +22,7 @@
/*!
* \file
- * \brief SIP-router core ::
+ * \brief SIP-router core :: kamailio compatible fixups
* \ingroup core
* Module: \ref core
*/
@@ -67,7 +62,7 @@ int fixup_regexpNL_none(void** param, int param_no); /* textops */
* @param maxp - maximum parameter number
* @param no1 - number of parameters of type1
* @param type1 - fix_param type for the 1st param
- * @paran type2 - fix_param type for all the other params
+ * @param type2 - fix_param type for all the other params
*/
#define FIXUP_F2FP(suffix, minp, maxp, no1, type1, type2) \
int fixup_##suffix (void** param, int param_no) \
diff --git a/modules/tls/tls_bio.c b/modules/tls/tls_bio.c
index 603caa8..f21a974 100644
--- a/modules/tls/tls_bio.c
+++ b/modules/tls/tls_bio.c
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2010 iptelorg GmbH
*
* Permission to use, copy, modify, and distribute this software for any
@@ -20,7 +18,6 @@
* openssl BIOs for reading/writing via a fixed memory buffer.
* @file
* @ingroup tls
- * @Module: @ref tls
*/
/*
diff --git a/modules/tls/tls_bio.h b/modules/tls/tls_bio.h
index 5336d6b..83128db 100644
--- a/modules/tls/tls_bio.h
+++ b/modules/tls/tls_bio.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2010 iptelorg GmbH
*
* Permission to use, copy, modify, and distribute this software for any
@@ -15,11 +13,12 @@
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+
/** openssl BIOs for reading/writing via a fixed memory buffer.
* @file modules/tls/tls_bio.h
* @ingroup tls
- * @Module: @ref tls
*/
+
/*
* History:
* --------
diff --git a/modules_k/presence/subscribe.h b/modules_k/presence/subscribe.h
index f6817cc..3e318a1 100644
--- a/modules_k/presence/subscribe.h
+++ b/modules_k/presence/subscribe.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* presence module - presence server implementation
*
* Copyright (C) 2006 Voice Sistem S.R.L.
@@ -28,7 +26,6 @@
/*! \file
* \brief Kamailio presence module :: SUBSCRIBE support
- * \ref subscribe.c
* \ingroup presence
*/
diff --git a/modules_k/tmx/t_mi.h b/modules_k/tmx/t_mi.h
index 3b10d57..9b5cbc4 100644
--- a/modules_k/tmx/t_mi.h
+++ b/modules_k/tmx/t_mi.h
@@ -1,6 +1,4 @@
/*
- * $Id: mi.h 4518 2008-07-28 15:39:28Z henningw $
- *
* Header file for TM MI functions
*
* Copyright (C) 2006 Voice Sistem SRL
@@ -31,7 +29,6 @@
*
* \ingroup tm
* - Module: \ref tm
- * - \ref mi.c
*/
#ifndef _TM_MI_H_
diff --git a/parser/parse_allow.c b/parser/parse_allow.c
index 6b60fea..da882f8 100644
--- a/parser/parse_allow.c
+++ b/parser/parse_allow.c
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (c) 2004 Juha Heinanen
*
* This file is part of ser, a free SIP server.
@@ -39,9 +37,8 @@
/*! \brief
* This method is used to parse Allow header.
*
- * \params msg : sip msg
- * \return 0 on success,
- * -1 on failure.
+ * \param hf message header field
+ * \return 0 on success, -1 on failure.
*/
int parse_allow_header(struct hdr_field* _hf)
{
diff --git a/parser/parse_allow.h b/parser/parse_allow.h
index 5d4dbce..5ce78aa 100644
--- a/parser/parse_allow.h
+++ b/parser/parse_allow.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (c) 2004 Juha Heinanen
*
* This file is part of ser, a free SIP server.
@@ -56,7 +54,10 @@ int parse_allow(struct sip_msg *msg);
/*! \brief
- * Parse Allow HF body
+ * This method is used to parse Allow header.
+ *
+ * \param hf message header field
+ * \return 0 on success, -1 on failure.
*/
int parse_allow_header(struct hdr_field* _h);
diff --git a/parser/parse_param.c b/parser/parse_param.c
index c68e237..6e8f653 100644
--- a/parser/parse_param.c
+++ b/parser/parse_param.c
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Generic Parameter Parser
*
* Copyright (C) 2001-2003 FhG Fokus
@@ -503,14 +501,11 @@ error:
/*! \brief
* Parse parameters
- * \param _s is string containing parameters, it will be updated to point behind the parameters
- * \param _c is class of parameters
- * \param _h is pointer to structure that will be filled with pointer to well known parameters
- * \param the variable _p is pointing to
- * linked list of parsed parameters will be stored
- *
- * The function returns 0 on success and negative number
- * on an error
+ * \param _s is string containing parameters, it will be updated to point behind the parameters
+ * \param _c is class of parameters
+ * \param _h is pointer to structure that will be filled with pointer to well known parameters
+ * \param _p pointing to linked list where parsed parameters will be stored
+ * \return 0 on success and negative number on an error
*/
int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p)
{
diff --git a/parser/parse_param.h b/parser/parse_param.h
index 6850577..1b92de6 100644
--- a/parser/parse_param.h
+++ b/parser/parse_param.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Generic Parameter Parser
*
* Copyright (C) 2001-2003 FhG Fokus
@@ -143,7 +141,7 @@ typedef union param_hooks {
/*! \brief
* Only parse one parameter
- * @Return:
+ * @return:
* t: out parameter
* -1: on error
* 0: success, but expect a next paramter
@@ -157,8 +155,7 @@ inline int parse_param(str *_s, pclass_t _c, param_hooks_t *_h, param_t *t);
* \param _s is string containing parameters
* \param _c is class of parameters
* \param _h is pointer to structure that will be filled with pointer to well known parameters
- * linked list of parsed parameters will be stored in
- * the variable _p is pointing to
+ * linked list of parsed parameters will be stored in the variable _p is pointing to
* \return The function returns 0 on success and negative number
* on an error
*/
diff --git a/rvalue.h b/rvalue.h
index cc9085c..cedc752 100644
--- a/rvalue.h
+++ b/rvalue.h
@@ -1,6 +1,4 @@
/*
- * $Id$
- *
* Copyright (C) 2008 iptelorg GmbH
*
* Permission to use, copy, modify, and distribute this software for any
@@ -15,10 +13,12 @@
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
+
/**
* @file
* @brief rvalue expressions
*/
+
/*
* History:
* --------
More information about the sr-dev
mailing list