diff --git a/kstats_types.h b/kstats_types.h index 3d4d9f2fe5f..11a4d34ff65 100644 --- a/kstats_types.h +++ b/kstats_types.h @@ -13,7 +13,8 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** kamailio statistics types. + +/** Kamailio Core :: kamailio statistics types. * This file contains type declaration for kamailio statistics. * They are needed when modules are loaded (sr_module.c). * The rest of kamailio stats are in lib/kcore (include @@ -22,13 +23,9 @@ * Note: kamailio statistics are obsolete. Use sr counters in new code * (counters.h). * @file kstats_types.h - * @ingroup: core + * @ingroup core + * @author andrei */ -/* - * History: - * -------- - * 2010-08-18 initial version (andrei) -*/ #ifndef __kstats_types_h #define __kstats_types_h diff --git a/list.h b/list.h index d712253aed9..bdbeccab3ed 100644 --- a/list.h +++ b/list.h @@ -1,4 +1,4 @@ -/*- +/* * Copyright (c) 1991, 1993 * The Regents of the University of California. All rights reserved. * diff --git a/local_timer.h b/local_timer.h index 75503ceac28..e981809200d 100644 --- a/local_timer.h +++ b/local_timer.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2007 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,14 +17,17 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* local timer routines +/*! +* \file +* \brief Kamailio core :: local timer routines +* \ingroup core +* \author andrei +* Module: \ref core +* * WARNING: this should be used only from within the same process. * The local timers are not multi-process or multi-thread safe * (there are no locks) * - * History: - * -------- - * 2007-11-22 created by andrei */ #ifndef _local_timer_h diff --git a/lock_alloc.h b/lock_alloc.h index 84e9dacd06c..145aa810986 100644 --- a/lock_alloc.h +++ b/lock_alloc.h @@ -1,21 +1,20 @@ -/* $Id$ */ /* * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions + * For a license to use the Kamailio software under conditions * other than those described here, or to purchase support for this * software, please contact iptel.org by e-mail at the following addresses: * info@iptel.org * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,15 +24,14 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* - * ser locking library +/*! +* \file +* \brief Kamailio core :: Kamailio locking library +* \author andrei +* \ingroup core +* Module: \ref core +* * WARNING: don't include this directly include instead locking.h! - * History: - * -------- - * 2003-03-06 created by andrei (contains parts of the original locking.h) - * 2003-03-17 fixed cast warning in shm_free (forced to void*) (andrei) - * 2004-07-28 s/lock_set_t/gen_lock_set_t/ because of a type conflict - * on darwin (andrei) * Implements: (see also locking.h) diff --git a/lock_ops.h b/lock_ops.h index 097d5bbdebd..0baa4e659f2 100644 --- a/lock_ops.h +++ b/lock_ops.h @@ -1,4 +1,3 @@ -/* $Id$ */ /* * * Copyright (C) 2001-2003 FhG Fokus @@ -16,25 +15,16 @@ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * ser locking library +/*! +* \file +* \brief Kamailio core :: Kamailio locking library +* \ingroup core +* \author andrei +* Module: \ref core +* * WARNING: do not include this file directly, use instead locking.h * (unless you don't need to alloc/dealloc locks) * - * 2002-12-16 created by andrei - * 2003-02-20 s/gen_lock_t/gen_lock_t/ to avoid a type conflict - * on solaris (andrei) - * 2003-03-05 lock set support added for FAST_LOCK & SYSV (andrei) - * 2003-03-06 removed *_alloc,*_dealloc & moved them to lock_alloc.h - * renamed locking.h to lock_ops.h (all this to solve - * the locking.h<->shm_mem.h interdependency) (andrei) - * 2003-03-10 lock set support added also for PTHREAD_MUTEX & POSIX_SEM - * (andrei) - * 2003-03-17 possible signal interruptions treated for sysv (andrei) - * 2004-07-28 s/lock_set_t/gen_lock_set_t/ because of a type conflict - * on darwin (andrei) - * 2006-04-04 added lock_try(lock) and lock_set_try(s,i) (andrei) - * 2007-05-13 added futex support (andrei) * Implements: diff --git a/lock_ops_init.h b/lock_ops_init.h index edad6bbe1dc..6eff737cb70 100644 --- a/lock_ops_init.h +++ b/lock_ops_init.h @@ -1,5 +1,4 @@ /* - * $Id$ * * Copyright (C) 2007 iptelorg GmbH * @@ -15,13 +14,12 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * lock_ops init functions - */ -/* - * History: - * -------- - * 2007-05-14 created by andrei +/*! +* \file +* \brief Kamailio core :: lock_ops init functions +* \ingroup core +* \author andrei +* Module: \ref core */ #ifndef __lock_ops_init_h diff --git a/locking.h b/locking.h index 6dfc11f0392..2d7e9343347 100644 --- a/locking.h +++ b/locking.h @@ -1,21 +1,15 @@ -/* $Id$ */ /* * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,17 +19,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* - * ser locking library +/*! +* \file +* \brief Kamailio core :: Kamailio locking library +* \ingroup core +* \author andrei +* Module: \ref core * - * 2002-12-16 created by andrei - * 2003-02-20 s/gen_lock_t/gen_lock_t/ to avoid a type conflict - * on solaris (andrei) - * 2003-03-05 lock set support added for FAST_LOCK & SYSV (andrei) - * 2003-03-06 split in two: lock_ops.h & lock_alloc.h, to avoid - * shm_mem.h<->locking.h interdependency (andrei) - * 2004-07-28 s/lock_set_t/gen_lock_set_t/ because of a type conflict - * on darwin (andrei) * Implements (in lock_ops.h & lock_alloc.h): diff --git a/lump_struct.h b/lump_struct.h index a9e53b2566a..ba07fa4cad5 100644 --- a/lump_struct.h +++ b/lump_struct.h @@ -1,23 +1,17 @@ /* - * $Id$ * * adding/removing headers or any other data chunk from a message * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -26,18 +20,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* History: - * -------- - * 2003-01-29 s/int/enum ... more convenient for gdb (jiri) - * 2003-03-31 added subst lumps -- they expand in ip addr, port a.s.o (andrei) - * 2003-04-01 added opt (condition) lumps (andrei) - * 2003-04-02 added more subst lumps: SUBST_{SND,RCV}_ALL - * => ip:port;transport=proto (andrei) - * 2003-10-20 split from data_lump.h (andrei) - * 2005-03-24 the type of type attribute changed to enum _hdr_types_t (janakj) - * - */ - +/*! +* \file +* \brief Kamailio core :: Adding/removing headers or any other data chunk from a message +* \ingroup core +* \author jiri, andrei, janakj +* Module: \ref core +*/ #ifndef lump_struct_h #define lump_struct_h diff --git a/lvalue.h b/lvalue.h index b5eccd439b2..0f48adb7190 100644 --- a/lvalue.h +++ b/lvalue.h @@ -1,5 +1,4 @@ /* - * $Id$ * * Copyright (C) 2008 iptelorg GmbH * @@ -18,11 +17,7 @@ /** * @file * @brief lvalues (assignment) - */ -/* - * History: - * -------- - * 2008-11-30 initial version (andrei) + * @author andrei */ #ifndef __lvalue_h_ diff --git a/md5utils.h b/md5utils.h index a16c8f324ac..a8df9cb941b 100644 --- a/md5utils.h +++ b/md5utils.h @@ -1,19 +1,14 @@ /* * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,7 +20,7 @@ /*! * \file - * \brief SIP-router core :: md5 hash support + * \brief Kamailio core :: MD5 digest support * \ingroup core * Module: \ref core */ diff --git a/mod_fix.h b/mod_fix.h index c7740d06fb0..36c2ec0d0ca 100644 --- a/mod_fix.h +++ b/mod_fix.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,13 @@ * 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.h * @brief Generic fixup functions for module function parameter. * (kamailio compatibility) + * @ingroup core + * Module: \ref core */ #ifndef _mod_fix_h_ diff --git a/modparam.h b/modparam.h index 8974c680b77..91c6867d596 100644 --- a/modparam.h +++ b/modparam.h @@ -1,22 +1,14 @@ /* - * $Id$ - * - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,6 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! +* \file +* \brief Kamailio core :: Module parameter handling (modparam) +* \ingroup core +* Module: \ref core +*/ #ifndef modparam_h diff --git a/msg_translator.h b/msg_translator.h index 01b56192e8e..5fa02cf2664 100644 --- a/msg_translator.h +++ b/msg_translator.h @@ -1,21 +1,14 @@ -/*$Id$ - * - * +/* * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,15 +17,16 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2003-03-06 totags in outgoing replies bookmarked to enable - * ACK/200 tag matching - * - * 2003-03-01 VOICE_MAIL defs removed (jiri) - * 2003-10-08 receive_test function-alized (jiri) */ +/*! +* \file +* \brief Kamailio core :: Message translations +* \author jiri +* \ingroup core +* Module: \ref core +*/ + #ifndef _MSG_TRANSLATOR_H #define _MSG_TRANSLATOR_H diff --git a/name_alias.h b/name_alias.h index 3493024e8cf..bfc15c8983c 100644 --- a/name_alias.h +++ b/name_alias.h @@ -1,22 +1,15 @@ /* - * $Id$ - * * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,12 +18,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* - * History: - * -------- - * 2003-03-19 replaced all mallocs/frees w/ pkg_malloc/pkg_free (andrei) - * 2003-10-21 support for proto added: proto:host:port (andrei) - */ +/*! +* \file +* \brief Kamailio core :: Name/alias handling +* \author andrei +* \ingroup core +* Module: \ref core +*/ @@ -52,7 +46,7 @@ extern struct host_alias* aliases; -/* returns 1 if name is in the alias list; if port=0, port no is ignored +/** returns 1 if name is in the alias list; if port=0, port no is ignored * if proto=0, proto is ignored*/ static inline int grep_aliases(char* name, int len, unsigned short port, unsigned short proto) @@ -74,7 +68,7 @@ static inline int grep_aliases(char* name, int len, unsigned short port, -/* adds an alias to the list (only if it isn't already there) +/** adds an alias to the list (only if it isn't already there) * if port==0, the alias will match all the ports * if proto==0, the alias will match all the protocols * returns 1 if a new alias was added, 0 if a matching alias was already on diff --git a/nonsip_hooks.h b/nonsip_hooks.h index 70480e4e81f..42ca35d0b97 100644 --- a/nonsip_hooks.h +++ b/nonsip_hooks.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2006 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,15 +17,15 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* +/*! + * \file + * \brief Kamailio core :: Non-sip callbacks * non-sip callbacks, called whenever a message with protocol != SIP/2.0 * is received (the message must have at least a sip like first line or * else they will be dropped before this callbacks are called - */ -/* - * History: - * -------- - * 2006-11-29 created by andrei + * \ingroup core + * \author andrei + * Module: \ref core */ diff --git a/onsend.h b/onsend.h index a8a4e6ed8ba..2ed68be3609 100644 --- a/onsend.h +++ b/onsend.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2005 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,14 +17,14 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* - * History: - * ------- - * 2005-12-11 created by andrei - * 2009-06-01 Pre- and post-script callbacks of onsend route are executed (Miklos) +/*! + * \file + * \brief Kamailio core :: IP address handling + * \author andrei + * \ingroup core + * Module: \ref core */ - #ifndef onsend_h #define onsend_h diff --git a/pass_fd.h b/pass_fd.h index 76d76f9cb26..e02087e2d06 100644 --- a/pass_fd.h +++ b/pass_fd.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,6 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! +* \file +* \brief Kamailio core :: File descriptor handling +* \ingroup core +* Module: \ref core +*/ #ifndef _pass_fd_h #define _pass_fd_h diff --git a/poll_types.h b/poll_types.h index 7440c887ff7..fd6767f624a 100644 --- a/poll_types.h +++ b/poll_types.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2005 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,18 +17,14 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* - * io wait poll methods (enum, strings, related function) - * see io_wait.h for more details - * - * +/*! + * \file + * \brief Kamailio core :: I/O wait poll methods (enum, strings, related function) + * see \ref io_wait.h for more details + * \ingroup core + * \author andrei + * Module: \ref core */ -/* - * History: - * -------- - * 2005-06-15 created by andrei - */ - #ifndef _poll_types_h #define _poll_types_h diff --git a/ppcfg.h b/ppcfg.h index d940f86b08a..69f41d2eb32 100644 --- a/ppcfg.h +++ b/ppcfg.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2010 Daniel-Constantin Mierla (asipto.com) * * Permission to use, copy, modify, and distribute this software for any @@ -15,8 +13,11 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * ppcfg.h - config preprocessor directives +/*! + * \file + * \brief Kamailio core :: Config preprocessor directives + * \ingroup core + * Module: \ref core */ #ifndef _PPCFG_H_ diff --git a/proxy.h b/proxy.h index 59f3a3eb6df..e0872406b5b 100644 --- a/proxy.h +++ b/proxy.h @@ -1,22 +1,14 @@ /* - * $Id$ - * - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,12 +17,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ - /* - * History: - * ------- - * 2003-02-13 added proto to struct proxy_l & to *_proxy functions (andrei) - */ - +/*! + * \file + * \brief Kamailio core :: Proxy + * \ingroup core + * \author andrei + * Module: \ref core + */ #ifndef proxy_h #define proxy_h @@ -70,7 +63,7 @@ void free_shm_proxy(struct proxy_l* p); -/* returns 0 on success, -1 on error (unknown af/bug) */ +/** returns 0 on success, -1 on error (unknown af/bug) */ inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p) { /* if error try next ip address if possible */ @@ -87,7 +80,7 @@ inline static int proxy2su(union sockaddr_union* su, struct proxy_l* p) -/* mark as proxy either as ok (err>=0) or as bad (err<0) */ +/** mark proxy either as ok (err>=0) or as bad (err<0) */ inline static void proxy_mark(struct proxy_l* p, int err) { if (err<0){ diff --git a/pt.h b/pt.h index b52be56653a..ed351a7b99e 100644 --- a/pt.h +++ b/pt.h @@ -1,10 +1,6 @@ /* - * $Id$ - * * Process Table * - * - * * Copyright (C) 2001-2003 FhG Fokus * * Permission to use, copy, modify, and distribute this software for any @@ -19,19 +15,11 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * History: - * -------- - * 2003-04-15 added tcp_disable support (andrei) - * 2006-06-14 added process table in shared mem (dragos) - * 2007-07-04 added register_fds() and get_max_open_fds(() (andrei) - */ -/** internal fork functions and process table. +/** Kamailio core :: internal fork functions and process table. * @file: pt.h * @ingroup core */ - #ifndef _PT_H #define _PT_H diff --git a/pv_core.h b/pv_core.h index e98480b1075..5f80556ccf0 100644 --- a/pv_core.h +++ b/pv_core.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2009 iptelorg GmbH * * Permission to use, copy, modify, and distribute this software for any @@ -15,9 +13,12 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * pv_core.h - */ +/*! +* \file +* \brief Kamailio core :: Pseudovariable handling core +* \ingroup core +* Module: \ref core +*/ #ifndef __pv_core_h #define __pv_core_h diff --git a/pvapi.h b/pvapi.h index 855e92bfe2b..1f2366e2b2b 100644 --- a/pvapi.h +++ b/pvapi.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2009 iptelorg GmbH * * Permission to use, copy, modify, and distribute this software for any @@ -15,8 +13,11 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * pvapi.h - pvapi init and destroy functions. +/*! + * \file + * \brief Kamailio core :: pvapi init and destroy functions. + * \ingroup core + * Module: \ref core */ #ifndef __pvapi_h__ diff --git a/pvar.h b/pvar.h index 4aa04dcbc66..601f0efba6b 100644 --- a/pvar.h +++ b/pvar.h @@ -1,16 +1,14 @@ /* - * $Id: items.h 2111 2007-05-01 11:18:08Z juhe $ - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of SIP-Router, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * SIP-Router is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * SIP-Router is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -22,7 +20,7 @@ /*! * \file - * \brief Definitions for Pseudo-variable support + * \brief Kamailio core :: Definitions for Pseudo-variable support */ diff --git a/qvalue.h b/qvalue.h index 231416d144c..4e2444bc32d 100644 --- a/qvalue.h +++ b/qvalue.h @@ -1,23 +1,16 @@ /* - * $Id$ - * * Handling of the q value * * Copyright (C) 2004 FhG FOKUS * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -26,9 +19,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History - * ------ - * 2004-04-25 created (janakj) + */ +/*! + * \file + * \brief Kamailio core :: Handling of the Q value + * \author janakj + * \ingroup core + * Module: \ref core */ #ifndef _QVALUE_H diff --git a/rad_dict.h b/rad_dict.h index 5354ca92e0a..3f0c2605ff0 100644 --- a/rad_dict.h +++ b/rad_dict.h @@ -3,19 +3,14 @@ * * Copyright (C) 2001-2003 FhG FOKUS * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,9 +19,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ - -/* - * WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you +/*! + * \file + * \brief Kamailio core :: Radius include file + * \ingroup core + * Module: \ref core + * + * \note WARNING: Don't forget to update sip_router/etc/dictionary.sip-router if you * update this file ! */ diff --git a/raw_listener.h b/raw_listener.h index 3ac7d842bdb..a1710703965 100644 --- a/raw_listener.h +++ b/raw_listener.h @@ -13,16 +13,12 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** raw socket udp listen functions. +/** Kamailio core :: raw socket udp listen functions. * @file raw_listener.h * @ingroup core + * @author andrei * Module: @ref core */ -/* - * History: - * -------- - * 2010-06-09 initial version (from older code) andrei - */ #ifndef _raw_listener_h #define _raw_listener_h diff --git a/raw_sock.h b/raw_sock.h index 868399fe177..fbb21bf125f 100644 --- a/raw_sock.h +++ b/raw_sock.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2010 iptelorg GmbH * * Permission to use, copy, modify, and distribute this software for any @@ -15,16 +13,13 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/** raw socket functions. + +/** Kamailio core :: raw socket functions. * @file raw_sock.c * @ingroup core + * @author andrei * Module: @ref core */ -/* - * History: - * -------- - * 2010-06-07 initial version (from older code) andrei - */ #ifndef _raw_sock_h #define _raw_sock_h diff --git a/re.h b/re.h index 1d6ea34138e..30d5ff6454b 100644 --- a/re.h +++ b/re.h @@ -1,23 +1,16 @@ /* - * $Id$ - * * regexp and regexp substitutions implementations * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -27,10 +20,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * - * History: - * -------- - * 2003-08-04 created by andrei - * 2004-11-12 minor api extension, added *count (andrei) + */ +/*! + * \file + * \brief Kamailio core :: regexp and regexp substitutions implementations + * \author andrei + * \ingroup core + * Module: \ref core */ #ifndef _re_h diff --git a/receive.h b/receive.h index a40fdc24fa7..4e6a13d3fd4 100644 --- a/receive.h +++ b/receive.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,6 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! +* \file +* \brief Kamailio core :: Receive msg function +* \ingroup core +* Module: \ref core +*/ diff --git a/resolve.h b/resolve.h index 3aa690aab82..fad783e4e66 100644 --- a/resolve.h +++ b/resolve.h @@ -1,23 +1,16 @@ /* - * $Id$ - * * resolver related functions * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -26,17 +19,14 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* History: - * -------- - * 2003-04-12 support for resolving ipv6 address references added (andrei) - * 2004-07-28 darwin needs nameser_compat.h (andrei) - * 2006-07-13 rdata structures put on diet (andrei) - * 2006-07-17 rdata contains now also the record name (andrei) - * 2006-08-18 get_record uses flags (andrei) - * 2006-06-16 naptr support (andrei) - */ - +/*! + * \file + * \brief Kamailio core :: DNS resolver + * \author andrei + * \ingroup core + * Module: \ref core + */ #ifndef __resolve_h #define __resolve_h diff --git a/route.h b/route.h index 4e3aca6cce1..b711c2a6d4e 100644 --- a/route.h +++ b/route.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,6 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! +* \file +* \brief Kamailio core :: Message routing +* \ingroup core +* Module: \ref core +*/ #ifndef route_h diff --git a/route_struct.h b/route_struct.h index 5d1aa15b70d..f1aaac4fc08 100644 --- a/route_struct.h +++ b/route_struct.h @@ -1,22 +1,14 @@ /* - * $Id$ - * - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -25,20 +17,14 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ -/* History: - * -------- - * - * 2003-04-12 FORCE_RPORT_T added (andrei) - * 2003-04-22 strip_tail added (jiri) - * 2003-10-10 >,<,>=,<=, != and MSGLEN_O added (andrei) - * 2003-10-28 FORCE_TCP_ALIAS added (andrei) - * 2004-02-24 added LOAD_AVP_T and AVP_TO_URI_T (bogdan) - * 2005-12-11 added SND{IP,PORT,PROTO,AF}_O & TO{IP,PORT}_O (andrei) - * 2005-12-19 select framework added SELECT_O and SELECT_ST (mma) - * 2008-12-17 added UDP_MTU_TRY_PROTO_T (andrei) +/*! + * \file + * \brief Kamailio core :: Route structure + * \ingroup core + * Module: \ref core + * \author andrei, bogdan */ - #ifndef route_struct_h #define route_struct_h diff --git a/rpc.h b/rpc.h index 91c1463b416..0eefc99a9c1 100644 --- a/rpc.h +++ b/rpc.h @@ -1,22 +1,16 @@ -/* $Id$ - * - * SER Remote Procedure Call Interface +/* + * Kamailio Remote Procedure Call Interface * * Copyright (C) 2005 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -26,6 +20,13 @@ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ +/*! +* \file +* \brief Kamailio core :: RPC, Remote procedure call interface +* \ingroup core +* Module: \ref core +*/ + #ifndef _RPC_H #define _RPC_H @@ -46,15 +47,15 @@ struct rpc_delayed_ctx; /* Send the result to the caller */ -typedef int (*rpc_send_f)(void* ctx); /* Send the reply to the client */ -typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...); /* Signal a failure to the client */ -typedef int (*rpc_add_f)(void* ctx, char* fmt, ...); /* Add a new piece of data to the result */ -typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...); /* Retrieve request parameters */ -typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...); /* Add printf-like formated data to the result set */ -typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...); /* Add fields in a structure */ -typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...); /* Add values in an array */ -typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...); /* Scan attributes of a structure */ -typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */ +typedef int (*rpc_send_f)(void* ctx); /*!< Send the reply to the client */ +typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...); /*!< Signal a failure to the client */ +typedef int (*rpc_add_f)(void* ctx, char* fmt, ...); /*!< Add a new piece of data to the result */ +typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...); /*!< Retrieve request parameters */ +typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...); /*!< Add printf-like formated data to the result set */ +typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...); /*!< Add fields in a structure */ +typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...); /*!< Add values in an array */ +typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...); /*!< Scan attributes of a structure */ +typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /*!< Struct version of rpc_printf */ /* returns the supported capabilities */ typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx); @@ -91,13 +92,12 @@ typedef struct rpc_delayed_ctx{ } rpc_delayed_ctx_t; -/* +/** * RPC Function Prototype */ - typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx); -/* +/** * RPC callback context. * * Defines a convenient way of packing an rpc callback @@ -110,14 +110,14 @@ typedef struct rpc_cb_ctx { } rpc_cb_ctx_t; -/* +/** * Remote Procedure Call Export */ typedef struct rpc_export { - const char* name; /* Name of the RPC function (null terminated) */ - rpc_function_t function; /* Pointer to the function */ - const char** doc_str; /* Documentation strings, method signature and description */ - unsigned int flags; /* Various flags, reserved for future use */ + const char* name; /*!< Name of the RPC function (null terminated) */ + rpc_function_t function; /*!< Pointer to the function */ + const char** doc_str; /*!< Documentation strings, method signature and description */ + unsigned int flags; /*!< Various flags, reserved for future use */ } rpc_export_t; diff --git a/rpc_lookup.h b/rpc_lookup.h index 53d40b68254..fb199af824c 100644 --- a/rpc_lookup.h +++ b/rpc_lookup.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2009 iptelorg GmbH * * Permission to use, copy, modify, and distribute this software for any @@ -15,14 +13,13 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * SER RPC lookup and register functions +/*! + * \file + * \brief Kamailio core :: Kamailio RPC lookup and register functions + * \ingroup core + * Module: \ref core + * \author andrei */ -/* - * History: - * -------- - * 2009-05-11 initial version (andrei) -*/ #ifndef __rpc_lookup_h #define __rpc_lookup_h diff --git a/rvalue.h b/rvalue.h index c0c2e0e7bf7..ccedfe5a114 100644 --- a/rvalue.h +++ b/rvalue.h @@ -19,18 +19,9 @@ * @brief SIP-router core :: rvalue expressions * @ingroup core * Module: \ref core + * @author andrei */ -/* - * History: - * -------- - * 2008-11-30 initial version (andrei) - * 2009-04-28 added string and interger versions for the EQ and DIFF - * operators (andrei) - * 2009-05-05 casts operator for int & string (andrei) - * 2010-03-16 space for an int2str result inside rval_cache (andrei) - */ - #ifndef _rvalue_h_ #define _rvalue_h_ diff --git a/sched_yield.h b/sched_yield.h index 45030c57343..1f8546d18f7 100644 --- a/sched_yield.h +++ b/sched_yield.h @@ -1,10 +1,6 @@ /* * sched_yield wrapper * - * $Id$ - * - * - * * Copyright (C) 2001-2003 FhG Fokus * * Permission to use, copy, modify, and distribute this software for any @@ -19,14 +15,14 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * - *History: - *-------- - * 2007-07-13 splitted from fastlock.h (andrei) +/*! + * \file + * \brief Kamailio core :: Sched_yield wrapper + * \ingroup core + * Module: \ref core + * \author andrei */ - #ifndef _sched_yield_h #define _sched_yield_h diff --git a/script_cb.h b/script_cb.h index 65361a00aa3..ece69b8e410 100644 --- a/script_cb.h +++ b/script_cb.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2001-2003 FhG Fokus * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,11 +17,12 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2005-02-13 script callbacks devided into request and reply types (bogdan) - * 2009-06-01 Added pre- and post-script callback support for all types - * of route blocks. (Miklos) + */ +/*! + * \file + * \brief Kamailio core :: Script callbacks + * \ingroup core + * Module: \ref core */ #ifndef _SCRIPT_CB_H_ diff --git a/sctp_core.h b/sctp_core.h index 88e04706108..c6b65b08683 100644 --- a/sctp_core.h +++ b/sctp_core.h @@ -1,6 +1,4 @@ /** - * $Id$ - * * Copyright (C) 2013 Daniel-Constantin Mierla (asipto.com) * * This file is part of Kamailio, a free SIP server. @@ -17,6 +15,13 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ +/*! + * \file + * \brief Kamailio core :: SCTP support + * \ingroup core + * Module: \ref core + * Copyright (C) 2013 Daniel-Constantin Mierla (asipto.com) + */ #ifndef __sctp_core_h__ #define __sctp_core_h__ diff --git a/select.h b/select.h index 3ed5c5b32b0..5d639d68175 100644 --- a/select.h +++ b/select.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2005-2006 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,10 +17,13 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2005-12-19 select framework (mma) - * 2006-01-19 multiple nested calls, IS_ALIAS -> NESTED flag renamed (mma) + */ +/*! + * \file + * \brief Kamailio core :: Selcct Framework + * \author mma + * \ingroup core + * Module: \ref core */ diff --git a/select_buf.h b/select_buf.h index 6543fbfe879..d8b7c54a20c 100644 --- a/select_buf.h +++ b/select_buf.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2005-2006 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,12 +17,14 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2006-06-16 static buffer for select results (mma) - * each process owns a separate space - * each request starts using the buffer from the start - * + */ + +/*! + * \file + * \brief Kamailio core :: Select result buffers + * \author mma + * \ingroup core + * Module: \ref core */ #ifndef SELECT_BUFFER_H @@ -37,7 +32,7 @@ #include "str.h" -/* +/** * Request for space from buffer * * Returns: NULL memory allocation failure (no more space) @@ -46,11 +41,10 @@ char* get_static_buffer(int req_size); -/* Internal function - called before request is going to be processed +/** Internal function - called before request is going to be processed * * Reset offset to unused space */ - int reset_static_buffer(void); int str_to_static_buffer(str* res, str* s); diff --git a/select_core.h b/select_core.h index a3192e4fc81..7f03a92de37 100644 --- a/select_core.h +++ b/select_core.h @@ -1,21 +1,14 @@ /* - * $Id$ - * * Copyright (C) 2005-2006 iptelorg GmbH * - * This file is part of ser, a free SIP server. + * This file is part of Kamailio, a free SIP server. * - * ser is free software; you can redistribute it and/or modify + * Kamailio 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 * (at your option) any later version * - * For a license to use the ser software under conditions - * other than those described here, or to purchase support for this - * software, please contact iptel.org by e-mail at the following addresses: - * info@iptel.org - * - * ser is distributed in the hope that it will be useful, + * Kamailio is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. @@ -24,13 +17,16 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - * History: - * -------- - * 2005-12-19 select framework, basic core functions (mma) - * 2006-01-19 multiple nested calls, IS_ALIAS -> NESTED flag renamed (mma) - * 2007-01-26 date, identity, identity_info support added (gergo) */ +/*! +* \file +* \brief Kamailio core :: Select framework, basic core functions +* \author mma +* \ingroup core +* Module: \ref core +*/ + #ifndef _SELECT_CORE_H #define _SELECT_CORE_H diff --git a/ser_time.h b/ser_time.h index 70da0022a0d..e4a00000dd0 100644 --- a/ser_time.h +++ b/ser_time.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * time related functions * * Copyright (C) 2006 iptelorg GmbH @@ -17,9 +15,13 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* History: - * -------- - * 2008-07-16 initial version (andrei) + +/*! + * \file + * \brief Kamailio core :: Time related functions + * \author andrei + * \ingroup core + * Module: \ref core */ #ifndef _ser_time_h #define _ser_time_h diff --git a/shm_init.h b/shm_init.h index 1e0d76f60d4..60b233f37f1 100644 --- a/shm_init.h +++ b/shm_init.h @@ -1,6 +1,4 @@ /* - * $Id$ - * * Copyright (C) 2010 iptelorg GmbH * * Permission to use, copy, modify, and distribute this software for any @@ -15,13 +13,12 @@ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ -/* - * shm_init.h - */ -/* - * History: - * -------- - * 2010-01-10 initial version (andrei) +/*! +* \file +* \brief Kamailio core :: Shared memory initialization +* \ingroup core +* \author andrei +* Module: \ref core */ #ifndef __shm_init_h