Doxygen updates (not done with this directory)
authoroej <oej@edvina.net>
Tue, 20 Oct 2009 20:20:22 +0000 (22:20 +0200)
committeroej <oej@edvina.net>
Tue, 20 Oct 2009 20:22:59 +0000 (22:22 +0200)
cfg/cfg.c
cfg/cfg.h
cfg/cfg_ctx.c
cfg/cfg_ctx.h
cfg/cfg_script.c
cfg/cfg_script.h
cfg/cfg_select.c
cfg/cfg_select.h
cfg/cfg_struct.c
cfg/cfg_struct.h
version.h

index a881fc2..0ae9ddb 100644 (file)
--- a/cfg/cfg.c
+++ b/cfg/cfg.c
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
 #include "cfg_script.h"
 #include "cfg.h"
 
-/* declares a new cfg group
+/*! \brief declares a new cfg group
+ *
  * handler is set to the memory area where the variables are stored
- * return value is -1 on error
+ * \return value is -1 on error
  */
 int cfg_declare(char *group_name, cfg_def_t *def, void *values, int def_size,
                        void **handle)
index 4a77233..8691805 100644 (file)
--- a/cfg/cfg.h
+++ b/cfg/cfg.h
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index a504588..408ac9f 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index e738c96..dbd9daa 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
@@ -37,7 +32,7 @@
 #include "cfg.h"
 #include "cfg_struct.h"
 
-/* linked list of variables with their new values */
+/*! \brief linked list of variables with their new values */
 typedef struct _cfg_changed_var {
        cfg_group_t     *group;
        cfg_mapping_t   *var;
@@ -47,10 +42,10 @@ typedef struct _cfg_changed_var {
        unsigned char   new_val[1];
 } cfg_changed_var_t;
 
-/* callback that is called when a new group is declared */
+/*! \brief callback that is called when a new group is declared */
 typedef void (*cfg_on_declare)(str *, cfg_def_t *);
 
-/* linked list of registered contexts */
+/*! \brief linked list of registered contexts */
 typedef struct _cfg_ctx {
        /* variables that are already changed
        but have not been committed yet */
@@ -70,14 +65,14 @@ typedef struct _cfg_ctx {
 #define CFG_CTX_LOCK(ctx)      lock_get(&(ctx)->lock)
 #define CFG_CTX_UNLOCK(ctx)    lock_release(&(ctx)->lock)
 
-/* creates a new config context that is an interface to the
+/*! \brief creates a new config context that is an interface to the
  * cfg variables with write permission */
 int cfg_register_ctx(cfg_ctx_t **handle, cfg_on_declare on_declare_cb);
 
-/* free the memory allocated for the contexts */
+/*! \brief free the memory allocated for the contexts */
 void cfg_ctx_destroy(void);
 
-/* set the value of a variable without the need of explicit commit */
+/*! \brief set the value of a variable without the need of explicit commit */
 int cfg_set_now(cfg_ctx_t *ctx, str *group_name, str *var_name,
                        void *val, unsigned int val_type);
 int cfg_set_now_int(cfg_ctx_t *ctx, str *group_name, str *var_name, int val);
@@ -91,33 +86,34 @@ int cfg_set_delayed_int(cfg_ctx_t *ctx, str *group_name, str *var_name, int val)
 int cfg_set_delayed_string(cfg_ctx_t *ctx, str *group_name, str *var_name, char *val);
 int cfg_set_delayed_str(cfg_ctx_t *ctx, str *group_name, str *var_name, str *val);
 
-/* commits the previously prepared changes within the context */
+/*! \brief commits the previously prepared changes within the context */
 int cfg_commit(cfg_ctx_t *ctx);
 
-/* drops the not yet committed changes within the context */
+/*! \brief drops the not yet committed changes within the context */
 int cfg_rollback(cfg_ctx_t *ctx);
 
-/* returns the value of a variable */
+/*! \brief returns the value of a variable */
 int cfg_get_by_name(cfg_ctx_t *ctx, str *group_name, str *var_name,
                        void **val, unsigned int *val_type);
 
-/* returns the description of a variable */
+/*! \brief returns the description of a variable */
 int cfg_help(cfg_ctx_t *ctx, str *group_name, str *var_name,
                        char **ch, unsigned int *input_type);
 
-/* notify the drivers about the new config definition */
+/*! \brief notify the drivers about the new config definition */
 void cfg_notify_drivers(char *group_name, int group_name_len, cfg_def_t *def);
 
-/* convert the value to the requested type */
+/*! \brief convert the value to the requested type */
 int convert_val(unsigned int val_type, void *val,
                        unsigned int var_type, void **new_val);
 
-/* initialize the handle for cfg_get_group_next() */
+/*! \brief initialize the handle for cfg_get_group_next() */
 #define cfg_get_group_init(handle) \
        (*(handle)) = (void *)cfg_group
 
-/* returns the group name and the cfg structure definition,
+/*! \brief returns the group name and the cfg structure definition,
  * and moves the handle to the next group
+ *
  * Return value:
  *     0: no more group
  *     1: group exists
@@ -133,15 +129,16 @@ int convert_val(unsigned int val_type, void *val,
 int cfg_get_group_next(void **h,
                        str *gname, cfg_def_t **def);
 
-/* Initialize the handle for cfg_diff_next()
+/*! \brief Initialize the handle for cfg_diff_next()
  * WARNING: keeps the context lock held, do not forget
  * to release it with cfg_diff_release()
  */
 int cfg_diff_init(cfg_ctx_t *ctx,
                void **h);
 
-/* return the pending changes that have not been
+/*! \brief return the pending changes that have not been
  * committed yet
+ *
  * can be used as follows:
  *
  * void *handle;
@@ -160,7 +157,7 @@ int cfg_diff_next(void **h,
                        void **old_val, void **new_val,
                        unsigned int *val_type);
 
-/* destroy the handle of cfg_diff_next() */
+/*! \brief destroy the handle of cfg_diff_next() */
 void cfg_diff_release(cfg_ctx_t *ctx);
 
 #endif /* _CFG_CTX_H */
index 8804e40..5f33ffd 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2008 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index 94fca11..e53236e 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2008 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index d8871ba..68c7e41 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2008 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index 6a03dd2..b7d454e 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2008 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index c204573..f2f5bfe 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
index 0be608e..c72573b 100644 (file)
@@ -3,19 +3,14 @@
  *
  * Copyright (C) 2007 iptelorg GmbH
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.
 #include "../compiler_opt.h"
 #include "cfg.h"
 
-/* indicates that the variable has been already shmized */
+/*! \brief indicates that the variable has been already shmized */
 #define cfg_var_shmized        1U
 
-/* structure used for variable - pointer mapping */
+/*! \brief structure used for variable - pointer mapping */
 typedef struct _cfg_mapping {
-       cfg_def_t       *def;           /* one item of the cfg structure definition */
-       int             name_len;       /* length of def->name */
+       cfg_def_t       *def;           /*!< one item of the cfg structure definition */
+       int             name_len;       /*!< length of def->name */
 
        /* additional information about the cfg variable */
-       int             offset; /* offest within the memory block */
-       unsigned int    flag;   /* flag indicating the state of the variable */
+       int             offset; /*!< offest within the memory block */
+       unsigned int    flag;   /*!< flag indicating the state of the variable */
 } cfg_mapping_t;
 
-/* linked list of registered groups */
+/*! \brief linked list of registered groups */
 typedef struct _cfg_group {
-       int             num;            /* number of variables within the group */
-       cfg_mapping_t   *mapping;       /* describes the mapping betweeen
+       int             num;            /*!< number of variables within the group */
+       cfg_mapping_t   *mapping;       /*!< describes the mapping betweeen
                                        the cfg variable definition and the memory block */
-       char            *vars;          /* pointer to the memory block where the values
+       char            *vars;          /*!< pointer to the memory block where the values
                                        are stored -- used only before the config is
                                        shmized. */
-       int             size;           /* size of the memory block that has to be
+       int             size;           /*!< size of the memory block that has to be
                                        allocated to store the values */
-       int             offset;         /* offset of the group within the
+       int             offset;         /*!< offset of the group within the
                                        shmized memory block */
-       void            **handle;       /* per-process handle that can be used
+       void            **handle;       /*!< per-process handle that can be used
                                        by the modules to access the variables.
                                        It is registered when the group is created,
                                        and updated every time the block is replaced */
 
-       unsigned char   dynamic;        /* indicates whether the variables within the group
+       unsigned char   dynamic;        /*!< indicates whether the variables within the group
                                        are dynamically allocated or not */
        struct _cfg_group       *next;
        int             name_len;       
        char            name[1];
 } cfg_group_t;
 
-/* single memoy block that contains all the cfg values */
+/*! \brief single memoy block that contains all the cfg values */
 typedef struct _cfg_block {
-       atomic_t        refcnt;         /* reference counter,
+       atomic_t        refcnt;         /*!< reference counter,
                                        the block is automatically deleted
                                        when it reaches 0 */
-       char            **replaced;     /* set of the strings that must be freed
+       char            **replaced;     /*!< set of the strings that must be freed
                                        together with the block. The content depends
                                        on the block that replaces this one */
-       unsigned char   vars[1];        /* blob that contains the values */
+       unsigned char   vars[1];        /*!< blob that contains the values */
 } cfg_block_t;
 
-/* Linked list of per-child process callbacks.
+/*! \brief Linked list of per-child process callbacks.
  * Each child process has a local pointer, and executes the callbacks
  * when the pointer is not pointing to the end of the list.
  * Items from the begginning of the list are deleted when the starter
  * pointer is moved, and no more child process uses them.
  */
 typedef struct _cfg_child_cb {
-       atomic_t                refcnt; /* number of child processes
+       atomic_t                refcnt; /*!< number of child processes
                                        referring to the element */
-       atomic_t                cb_count;       /* This counter is used to track
+       atomic_t                cb_count;       /*!< This counter is used to track
                                                 * how many times the callback needs
                                                 * to be executed.
                                                 * >0 the cb needs to be executed
                                                 * <=0 the cb no longer needs to be executed
                                                 */
-       str                     gname, name;    /* name of the variable that has changed */
-       cfg_on_set_child        cb;     /* callback function that has to be called */
+       str                     gname, name;    /*!< name of the variable that has changed */
+       cfg_on_set_child        cb;     /*!< callback function that has to be called */
 
        struct _cfg_child_cb    *next;
 } cfg_child_cb_t;
index fe45438..056e885 100644 (file)
--- a/version.h
+++ b/version.h
@@ -6,19 +6,14 @@
  *
  * Copyright (C) 2004 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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,
+ * SIP-router 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.