srutils Update headers, add doxygen, remove svn ID and history

lib/srutils/README

@@ -1,7 +1,7 @@
 Library collecting various utility components needed by several modules
 #######################################################################
 
-The licesing matches the rules for core - owned by FhG or more liberal
+The licensing matches the rules for core - owned by FhG or more liberal
 like BSD or MIT style.
 
 1. TMREC
@@ -15,17 +15,17 @@ COS - RFC 2445)
 =========
 
 Adapted verision of cJSON - a C JSON parsing library - that integrates better
-with Kamailio/SER environment.
+with Kamailio environment.
 
 The changes so far:
   - rename cJSON to srjson to avoid name space conflicts
   - ability to specify malloc/free functions per JSON document. In
-  Kamailio/SER, based on needs, it can be PKG or SHM type of used memory.
+  Kamailio based on needs, it can be PKG or SHM type of used memory.
   - ability to add a string value by pointer and length - the very common
   str structure
 
 Next targets:
-  - option to clone or not the full JSON document buffer and parse using
+- option to clone or not the full JSON document buffer and parse using
   the clone (tied to and becomes usefule with the next item in this list)
   - don't clone the string values when parsing a JSON document, but set
   references to names and string values

lib/srutils/shautils.c

@@ -19,6 +19,16 @@
  * along with this program; if not, write to the Free Software 
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  */
+/*! @defgroup srutils Various utilities
+ *
+ * Kamailio core library.
+ */
+/*!
+* \file
+* \brief srutils :: SHA and other hashing utilities
+* \ingroup srutils
+* Module: \ref srutils
+*/
 
 #include "../../md5.h"
 #include "../../ut.h"

lib/srutils/shautils.h

@@ -19,6 +19,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 srutils :: SHA and other hashing utilities
+* \ingroup srutils
+* Module: \ref srutils
+*/
 
 #ifndef _SHAUTILS_H_
 #define _SHAUTILS_H_

lib/srutils/srjson.c

@@ -20,8 +20,11 @@
    THE SOFTWARE.
    */
 
-/**
- * srjson - JSON parser in C - MIT License
+/*!
+ * \file
+ * \brief srutils :: SRjson - JSON parser in C - MIT License
+ * \ingroup srutils
+ * Module: \ref srutils
  * - addapted from cJSON to fit better within Kamailio/SER environment
  */
 

lib/srutils/srjson.h

@@ -19,6 +19,12 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
   THE SOFTWARE.
 */
+/*!
+* \file
+* \brief srutils :: SRjson
+* \ingroup srutils
+* Module: \ref srutils
+*/
 
 #ifndef _srjson__h_
 #define _srjson__h_

lib/srutils/sruid.c

@@ -1,5 +1,4 @@
 /*
- * $Id$
  *
  * sruid - unique id generator
  *
@@ -21,6 +20,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 srutils :: Unique ID generator
+* \ingroup srutils
+* Module: \ref srutils
+*/
 
 #include <stdio.h>
 #include <unistd.h>

lib/srutils/sruid.h

@@ -1,6 +1,4 @@
 /*
- * $Id$
- *
  * sruid - unique id generator
  *
  * Copyright (C) 2012 Daniel-Constantin Mierla (asipto.com)
@@ -21,6 +19,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 srutils :: Unique ID generator
+* \ingroup srutils
+* Module: \ref srutils
+*/
 
 #ifndef _SRUID_H_
 #define _SRUID_H_

lib/srutils/tmrec.c

@@ -1,5 +1,4 @@
 /*
- * $Id$
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
@@ -25,7 +24,9 @@
  * Time Recurence Library according to iCalendar (RFC 2445)
  * - implemented at FhG Fokus, 2003 - external link:
  *   https://github.com/miconda/tmrec
- * - this is a clone adapted for kamailio/ser
+ * \brief srutils :: <description of this file>
+ * \ingroup srutils
+ * Module: \ref srutils
  */
 
 #include <stdio.h>