Browse code

More parser/ doxygen changes

oej authored on 25/10/2009 17:26:46
Showing 23 changed files
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,13 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Allow header
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+
28 30
 #include <stdlib.h>
29 31
 #include <string.h>
30 32
 #include "../dprint.h"
... ...
@@ -34,11 +36,11 @@
34 36
 #include "msg_parser.h"
35 37
 
36 38
  
37
-/*
39
+/*! \brief
38 40
  * This method is used to parse Allow header.
39 41
  *
40
- * params: msg : sip msg
41
- * returns 0 on success,
42
+ * \params  msg : sip msg
43
+ * \return 0 on success,
42 44
  *        -1 on failure.
43 45
  */
44 46
 int parse_allow_header(struct hdr_field* _hf)
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -24,6 +19,13 @@
24 19
  * along with this program; if not, write to the Free Software 
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
22
+
23
+/*! \file
24
+ * \brief Parser :: Allow header
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
27 29
  
28 30
 #ifndef PARSE_ALLOW_H
29 31
 #define PARSE_ALLOW_H
... ...
@@ -32,7 +34,7 @@
32 34
 #include "msg_parser.h"
33 35
 
34 36
  
35
-/* 
37
+/*! \brief
36 38
  * casting macro for accessing Allow body 
37 39
  */
38 40
 #define get_allow_methods(p_msg)							\
... ...
@@ -40,26 +42,26 @@
40 42
 
41 43
 
42 44
 struct allow_body {
43
-	unsigned int allow;     /* allow mask for the current hdr */
44
-	unsigned int allow_all; /* allow mask for the all allow hdr - it's
45
+	unsigned int allow;     /*!< allow mask for the current hdr */
46
+	unsigned int allow_all; /*!< allow mask for the all allow hdr - it's
45 47
 							 * set only for the first hdr in sibling
46 48
 							 * list*/
47 49
 };
48 50
 
49 51
 
50
-/*
52
+/*! \brief
51 53
  * Parse all Allow HFs
52 54
  */
53 55
 int parse_allow(struct sip_msg *msg);
54 56
 
55 57
 
56
-/*
58
+/*! \brief
57 59
  * Parse Allow HF body
58 60
  */
59 61
 int parse_allow_header(struct hdr_field* _h);
60 62
 
61 63
 
62
-/*
64
+/*! \brief
63 65
  * Release memory
64 66
  */
65 67
 void free_allow_body(struct allow_body **ab);
... ...
@@ -29,6 +29,13 @@
29 29
  *  2008-05-22  Initial version, get_body_part() is introduced (Miklos)
30 30
  */
31 31
 
32
+/*! \file
33
+ * \brief Parser :: Body handling
34
+ *
35
+ * \ingroup parser
36
+ */
37
+
38
+
32 39
 #include "../trim.h"
33 40
 #include "parser_f.h"
34 41
 #include "parse_content.h"
... ...
@@ -36,7 +43,7 @@
36 43
 #include "keys.h"
37 44
 #include "parse_body.h"
38 45
 
39
-/* returns the value of boundary parameter from the Contect-Type HF */
46
+/*! \brief returns the value of boundary parameter from the Contect-Type HF */
40 47
 static inline int get_boundary_param(struct sip_msg *msg, str *boundary)
41 48
 {
42 49
 	str	s;
... ...
@@ -91,7 +98,7 @@ static inline int get_boundary_param(struct sip_msg *msg, str *boundary)
91 98
 	return 0;
92 99
 }
93 100
 
94
-/* search the next boundary in the buffer */
101
+/*! \brief search the next boundary in the buffer */
95 102
 static inline char *search_boundary(char *buf, char *buf_end, str *boundary)
96 103
 {
97 104
 	char *c;
... ...
@@ -110,7 +117,7 @@ static inline char *search_boundary(char *buf, char *buf_end, str *boundary)
110 117
 	return NULL;
111 118
 }
112 119
 
113
-/* extract the body of a part from a multipart SIP msg body */
120
+/*! \brief extract the body of a part from a multipart SIP msg body */
114 121
 inline static char *get_multipart_body(char *buf,
115 122
 					char *buf_end,
116 123
 					str *boundary,
... ...
@@ -155,13 +162,13 @@ error:
155 162
 }
156 163
 
157 164
 
158
-/* macros from parse_hname2.c */
165
+/*! \brief macros from parse_hname2.c */
159 166
 #define READ(val) \
160 167
 (*(val + 0) + (*(val + 1) << 8) + (*(val + 2) << 16) + (*(val + 3) << 24))
161 168
 
162 169
 #define LOWER_DWORD(d) ((d) | 0x20202020)
163 170
 
164
-/* Returns the pointer within the msg body to the given type/subtype,
171
+/*! \brief Returns the pointer within the msg body to the given type/subtype,
165 172
  * and sets the length of the body part.
166 173
  * The result can be the whole msg body, or a part of a multipart body.
167 174
  */
... ...
@@ -25,11 +25,17 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  *
27 27
  */
28
+/*! \file
29
+ * \brief Parser :: Body handling
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
28 34
 
29 35
 #ifndef PARSE_BODY_H
30 36
 #define PARSE_BODY_H
31 37
 
32
-/* Returns the pointer within the msg body to the given type/subtype,
38
+/*! \brief Returns the pointer within the msg body to the given type/subtype,
33 39
  * and sets the length.
34 40
  * The result can be the whole msg body, or a part of a multipart body.
35 41
  */
... ...
@@ -11,11 +11,6 @@
11 11
  * the Free Software Foundation; either version 2 of the License, or
12 12
  * (at your option) any later version
13 13
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19 14
  * ser is distributed in the hope that it will be useful,
20 15
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 16
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -35,6 +30,12 @@
35 30
  *		some remaining characters (Miklos)
36 31
  */
37 32
 
33
+/*! \file
34
+ * \brief Parser :: Content part
35
+ *
36
+ * \ingroup parser
37
+ */
38
+
38 39
 
39 40
 #include <stdio.h>
40 41
 #include <stdlib.h>
... ...
@@ -53,15 +54,15 @@
53 54
 	( (isalpha((int)_c_)?(((_c_)|0x20)==(_cs_)):((_c_)==(_cs_)))==1 )
54 55
 
55 56
 
56
-/*
57
+/*! \brief
57 58
  * Node of the type's tree; this tree contains all the known types;
58 59
  */
59 60
 typedef struct type_node_s {
60
-	char c;                      /* char contained by this node */
61
-	unsigned char final;         /* says what mime type/subtype was detected
62
-	                              * if string ends at this node */
63
-	unsigned char nr_sons;       /* the number of sub-nodes */
64
-	int next;                    /* the next sibling node */
61
+	char c;                      /*!< char contained by this node */
62
+	unsigned char final;         /*!< says what mime type/subtype was detected
63
+	                              *!< if string ends at this node */
64
+	unsigned char nr_sons;       /*!< the number of sub-nodes */
65
+	int next;                    /*!< the next sibling node */
65 66
 }type_node_t;
66 67
 
67 68
 
... ...
@@ -379,9 +380,11 @@ error:
379 380
 
380 381
 
381 382
 
382
-/* returns: > 0 mime found
383
- *          = 0 hdr not found
384
- *          =-1 error */
383
+/*! \brief
384
+ * \return
385
+ *  	-   > 0 mime found
386
+ *      -   = 0 hdr not found
387
+ *      -   =-1 error */
385 388
 int parse_content_type_hdr( struct sip_msg *msg )
386 389
 {
387 390
 	char *end;
... ...
@@ -485,7 +488,8 @@ error:
485 488
 	return -1;
486 489
 }
487 490
 
488
-/* returns: > 0 ok
491
+/*! \brief
492
+ * returns: > 0 ok
489 493
  *          = 0 hdr not found
490 494
  *          = -1 error */
491 495
 int parse_accept_hdr( struct sip_msg *msg )
... ...
@@ -11,11 +11,6 @@
11 11
  * the Free Software Foundation; either version 2 of the License, or
12 12
  * (at your option) any later version
13 13
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19 14
  * ser is distributed in the hope that it will be useful,
20 15
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 16
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -26,6 +21,13 @@
26 21
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27 22
  */
28 23
 
24
+/*! \file
25
+ * \brief Parser :: Content
26
+ *
27
+ * \ingroup parser
28
+ */
29
+
30
+
29 31
 #ifndef _PARSE_CONTENT_H
30 32
 #define _PARSE_CONTENT_H
31 33
 
... ...
@@ -39,9 +41,10 @@ struct mime_type {
39 41
 
40 42
 
41 43
 
42
-/*
43
- * Mimes types/subtypes that are recognize
44
+/*! \name MimeTypes
45
+ * Mimes types/subtypes that are recognized
44 46
  */
47
+/*! { */
45 48
 #define TYPE_TEXT            1
46 49
 #define TYPE_MESSAGE         2
47 50
 #define TYPE_APPLICATION     3
... ...
@@ -66,34 +69,35 @@ struct mime_type {
66 69
 #define SUBTYPE_ALL          0xfe
67 70
 #define SUBTYPE_UNKNOWN      0xff
68 71
 
72
+/*! } */
69 73
 
70
-/* taken from PA module - will be useful here */
74
+/*! \brief taken from PA module - will be useful here */
71 75
 #define MIMETYPE(x_,y_) ((TYPE_##x_ << 16) | (SUBTYPE_##y_))
72 76
 
73
-/*
77
+/*! \brief
74 78
  * Maximum number of mimes allowed in Accept header 
75 79
  */
76 80
 #define MAX_MIMES_NR         128
77 81
 
78
-/*
82
+/*! \brief
79 83
  * returns the content-length value of a sip_msg as an integer
80 84
  */
81 85
 #define get_content_length(_msg_)   ((long)((_msg_)->content_length->parsed))
82 86
 
83 87
 
84
-/*
88
+/*! \brief
85 89
  * returns the content-type value of a sip_msg as an integer
86 90
  */
87 91
 #define get_content_type(_msg_)   ((int)(long)((_msg_)->content_type->parsed))
88 92
 
89 93
 
90
-/*
94
+/*! \brief
91 95
  * returns the accept values of a sip_msg as an null-terminated array
92 96
  * of integer
93 97
  */
94 98
 #define get_accept(_msg_) ((int*)((_msg_)->accept->parsed))
95 99
 
96
-/*
100
+/*! \brief
97 101
  * parse the body of the Content-Type header. It's value is also converted
98 102
  * as int.
99 103
  * Returns:   n (n>0)  : the found type
... ...
@@ -104,7 +108,7 @@ int parse_content_type_hdr( struct sip_msg *msg);
104 108
 
105 109
 int parse_accept_body(struct hdr_field *hdr);
106 110
 
107
-/*
111
+/*! \brief
108 112
  * parse the body of the Accept header. It's values are also converted
109 113
  * as an null-terminated array of ints.
110 114
  * Returns:   1 : OK
... ...
@@ -114,14 +118,14 @@ int parse_accept_body(struct hdr_field *hdr);
114 118
 int parse_accept_hdr( struct sip_msg *msg );
115 119
 
116 120
 
117
-/*
121
+/*! \brief
118 122
  *  parse the body of a Content_-Length header. Also tries to recognize the
119 123
  *  type specified by this header (see th above defines).
120 124
  *  Returns the first chr after the end of the header.
121 125
  */
122 126
 char* parse_content_length( char* buffer, char* end, int* len);
123 127
 
124
-/*
128
+/*! \brief
125 129
  * Sets the mime type from the body of a Content-Type header
126 130
  */
127 131
 char* decode_mime_type(char *start, char *end, unsigned int *mime_type);
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -30,6 +25,13 @@
30 25
  * 2003-01-22 zero-termination in CSeq eliminated (jiri)
31 26
  */
32 27
 
28
+/*! \file
29
+ * \brief Parser :: Cseq header field handling
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
34
+
33 35
 
34 36
 #include "../comp_defs.h"
35 37
 #include "parse_cseq.h"
... ...
@@ -39,10 +41,6 @@
39 41
 #include "parse_methods.h"
40 42
 #include "../mem/mem.h"
41 43
 
42
-/*
43
- * Parse CSeq header field
44
- */
45
-
46 44
 /*BUGGY*/
47 45
 char* parse_cseq(char *buf, char* end, struct cseq_body* cb)
48 46
 {
... ...
@@ -25,6 +25,13 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse CSEQ header
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
34
+
28 35
 
29 36
 #ifndef PARSE_CSEQ
30 37
 #define PARSE_CSEQ
... ...
@@ -33,24 +40,24 @@
33 40
 
34 41
 
35 42
 struct cseq_body{
36
-	int error;  /* Error code */
37
-	str number; /* CSeq number */
38
-	str method; /* Associated method */
39
-	unsigned int method_id; /* Associated method ID */
43
+	int error;  /*!< Error code */
44
+	str number; /*!< CSeq number */
45
+	str method; /*!< Associated method */
46
+	unsigned int method_id; /*!< Associated method ID */
40 47
 };
41 48
 
42 49
 
43
-/* casting macro for accessing CSEQ body */
50
+/*! \brief casting macro for accessing CSEQ body */
44 51
 #define get_cseq(p_msg) ((struct cseq_body*)(p_msg)->cseq->parsed)
45 52
 
46 53
 
47
-/*
54
+/*! \brief
48 55
  * Parse CSeq header field
49 56
  */
50 57
 char* parse_cseq(char *buf, char* end, struct cseq_body* cb);
51 58
 
52 59
 
53
-/*
60
+/*! \brief
54 61
  * Free all associated memory
55 62
  */
56 63
 void free_cseq(struct cseq_body* cb);
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,13 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Date header
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+
28 30
 
29 31
 #include <string.h>
30 32
 #include "parse_date.h"
... ...
@@ -48,7 +50,7 @@ inline static int char2int (char *p, int *t)
48 50
 	return 0;
49 51
 }
50 52
 
51
-/*
53
+/*! \brief
52 54
  * Converts a RFC 1123 formatted date string to stuct tm
53 55
  */
54 56
 static int rfc1123totm (char *stime, struct tm *ttm ) {
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,13 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Date header
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+
28 30
 
29 31
 #ifndef PARSE_DATE
30 32
 #define PARSE_DATE
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,13 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Definitions
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+
28 30
 
29 31
 #ifndef PARSE_DEF_H
30 32
 #define PARSE_DEF_H
... ...
@@ -11,11 +11,6 @@
11 11
  * the Free Software Foundation; either version 2 of the License, or
12 12
  * (at your option) any later version
13 13
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19 14
  * ser is distributed in the hope that it will be useful,
20 15
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 16
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -29,6 +24,12 @@
29 24
  * 2003-09-09 created (bogdan)
30 25
  */
31 26
 
27
+/*! \file
28
+ * \brief Parser :: Content-Disposition header
29
+ *
30
+ * \ingroup parser
31
+ */
32
+
32 33
 
33 34
 #include <stdio.h>
34 35
 #include <stdlib.h>
... ...
@@ -41,7 +42,7 @@
41 42
 
42 43
 
43 44
 
44
-/* parse a string that supposed to be a disposition and fills up the structure
45
+/*! \brief parse a string that supposed to be a disposition and fills up the structure
45 46
  * Returns: -1 : error
46 47
  *           o : success */
47 48
 int parse_disposition( str *s, struct disposition *disp)
... ...
@@ -346,7 +347,7 @@ error:
346 347
 
347 348
 
348 349
 
349
-/* Frees the entire disposition structure (params + itself) */
350
+/*! \brief Frees the entire disposition structure (params + itself) */
350 351
 void free_disposition( struct disposition **disp)
351 352
 {
352 353
 	struct disposition_param *param;
... ...
@@ -363,7 +364,7 @@ void free_disposition( struct disposition **disp)
363 364
 
364 365
 
365 366
 
366
-/* looks inside the message, gets the Content-Disposition hdr, parse it, builds
367
+/*! \brief looks inside the message, gets the Content-Disposition hdr, parse it, builds
367 368
  * and fills a disposition structure for it what will be attached to hdr as
368 369
  * parsed link.
369 370
  * Returns:  -1 : error
... ...
@@ -413,7 +414,7 @@ error:
413 414
 }
414 415
 
415 416
 
416
-/* Prints recursive a disposition structure */
417
+/*! \brief Prints recursive a disposition structure */
417 418
 void print_disposition( struct disposition *disp)
418 419
 {
419 420
 	struct disposition_param *param;
... ...
@@ -11,11 +11,6 @@
11 11
  * the Free Software Foundation; either version 2 of the License, or
12 12
  * (at your option) any later version
13 13
  *
14
- * For a license to use the ser software under conditions
15
- * other than those described here, or to purchase support for this
16
- * software, please contact iptel.org by e-mail at the following addresses:
17
- *    info@iptel.org
18
- *
19 14
  * ser is distributed in the hope that it will be useful,
20 15
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 16
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -29,6 +24,13 @@
29 24
  * 2003-09-09 created (bogdan)
30 25
  */
31 26
 
27
+/*! \file
28
+ * \brief Parser :: Content-Disposition header
29
+ *
30
+ * \ingroup parser
31
+ */
32
+
33
+
32 34
 #ifndef _PARSE_DISPOSITION_H_
33 35
 #define _PARSE_DISPOSITION_H_
34 36
 
... ...
@@ -54,7 +56,7 @@ struct disposition {
54 56
 };
55 57
 
56 58
 
57
-/* looks inside the message, gets the Content-Disposition hdr, parse it, builds
59
+/*! \brief looks inside the message, gets the Content-Disposition hdr, parse it, builds
58 60
  * and fills a disposition structure for it what will be attached to hdr as
59 61
  * parsed link.
60 62
  * Returns:  -1 : error
... ...
@@ -64,16 +66,16 @@ struct disposition {
64 66
 int parse_content_disposition( struct sip_msg *msg );
65 67
 
66 68
 
67
-/* parse a string that supposed to be a disposition and fills up the structure
69
+/*! \brief parse a string that supposed to be a disposition and fills up the structure
68 70
  * Returns: -1 : error
69 71
  *           o : success */
70 72
 int parse_disposition( str *s, struct disposition *disp);
71 73
 
72 74
 
73
-/* Frees the entire disposition structure (params + itself) */
75
+/*! \brief Frees the entire disposition structure (params + itself) */
74 76
 void free_disposition( struct disposition **disp);
75 77
 
76
-/* Prints recursive a disposition structure */
78
+/*! \brief Prints recursive a disposition structure */
77 79
 void print_disposition( struct disposition *disp);
78 80
 
79 81
 #endif
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -24,6 +19,13 @@
24 19
  * along with this program; if not, write to the Free Software 
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
22
+
23
+/*! \file
24
+ * \brief Parser :: Diversion header
25
+ * 
26
+ * \ingroup parser
27
+ */
28
+
27 29
  
28 30
 #include <stdlib.h>
29 31
 #include <string.h> 
... ...
@@ -34,7 +36,7 @@
34 36
 #include "parse_to.h"
35 37
 #include "msg_parser.h"
36 38
 
37
-/*
39
+/*! \brief
38 40
  * This method is used to parse DIVERSION header.
39 41
  *
40 42
  * params: msg : sip msg
... ...
@@ -78,7 +80,7 @@ int parse_diversion_header(struct sip_msg *msg)
78 80
 }
79 81
 
80 82
 
81
-/**
83
+/*! \brief
82 84
  * Get the value of a given diversion parameter
83 85
  */
84 86
 str *get_diversion_param(struct sip_msg *msg, str* name)
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -24,6 +19,13 @@
24 19
  * along with this program; if not, write to the Free Software 
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
22
+
23
+/*! \file
24
+ * \brief Parser :: Diversion header
25
+ * 
26
+ * \ingroup parser
27
+ */
28
+
27 29
  
28 30
 #ifndef PARSE_DIVERSION_H
29 31
 #define PARSE_DIVERSION_H
... ...
@@ -31,16 +33,16 @@
31 33
 #include "msg_parser.h"
32 34
  
33 35
 
34
-/* casting macro for accessing Diversion body */
36
+/*! \brief casting macro for accessing Diversion body */
35 37
 #define get_diversion(p_msg)  ((struct to_body*)(p_msg)->diversion->parsed)
36 38
  
37 39
  
38
-/*
40
+/*! \brief
39 41
  * Diversion header field parser
40 42
  */
41 43
 int parse_diversion_header(struct sip_msg *msg);
42 44
  
43
-/**
45
+/*! \brief
44 46
  * Get the value of a given diversion parameter
45 47
  */
46 48
 str *get_diversion_param(struct sip_msg *msg, str* name);
... ...
@@ -2,10 +2,6 @@
2 2
  * $Id$
3 3
  *
4 4
  * Event header field body parser.
5
- * The parser was written for Presence Agent module only.
6
- * it recognize presence package only, no sub-packages, no parameters
7
- * It should be replaced by a more generic parser if sub-packages or
8
- * parameters should be parsed too.
9 5
  *
10 6
  * Copyright (C) 2001-2003 FhG Fokus
11 7
  *
... ...
@@ -16,11 +12,6 @@
16 12
  * the Free Software Foundation; either version 2 of the License, or
17 13
  * (at your option) any later version
18 14
  *
19
- * For a license to use the ser software under conditions
20
- * other than those described here, or to purchase support for this
21
- * software, please contact iptel.org by e-mail at the following addresses:
22
- *    info@iptel.org
23
- *
24 15
  * ser is distributed in the hope that it will be useful,
25 16
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
26 17
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -35,6 +26,17 @@
35 26
  * 2003-04-26 ZSW (jiri)
36 27
  */
37 28
 
29
+/*! \file
30
+ * \brief Parser :: Event header field body parser.
31
+ *
32
+ * The parser was written for Presence Agent module only.
33
+ * it recognize presence package only, no sub-packages, no parameters
34
+ * It should be replaced by a more generic parser if sub-packages or
35
+ * parameters should be parsed too.
36
+ *
37
+ * \ingroup parser
38
+ */
39
+
38 40
 
39 41
 #include "parse_event.h"
40 42
 #include "../mem/mem.h"    /* pkg_malloc, pkg_free */
... ...
@@ -141,7 +143,7 @@ int event_parser(char* s, int len, event_t* e)
141 143
 }
142 144
 
143 145
 
144
-/*
146
+/*! \brief
145 147
  * Parse Event header field body
146 148
  */
147 149
 int parse_event(struct hdr_field* _h)
... ...
@@ -171,7 +173,7 @@ int parse_event(struct hdr_field* _h)
171 173
 }
172 174
 
173 175
 
174
-/*
176
+/*! \brief
175 177
  * Free all memory
176 178
  */
177 179
 void free_event(event_t** _e)
... ...
@@ -184,7 +186,7 @@ void free_event(event_t** _e)
184 186
 }
185 187
 
186 188
 
187
-/*
189
+/*! \brief
188 190
  * Print structure, for debugging only
189 191
  */
190 192
 void print_event(event_t* e)
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,13 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Event header field body parser.
25
+ *
26
+ *
27
+ * \ingroup parser
28
+ */
29
+
28 30
 
29 31
 #ifndef PARSE_EVENT_H
30 32
 #define PARSE_EVENT_H
... ...
@@ -31,6 +31,14 @@
31 31
  * 2003-04-26 ZSW (jiri)
32 32
  */
33 33
 
34
+/*! \file
35
+ * \brief Parser :: Expires header field body parser.
36
+ *
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
41
+
34 42
 
35 43
 #include "parse_expires.h"
36 44
 #include <stdio.h>          /* printf */
... ...
@@ -99,7 +107,7 @@ static inline int expires_parser(char* _s, int _l, exp_body_t* _e)
99 107
 }
100 108
 
101 109
 
102
-/*
110
+/*! \brief
103 111
  * Parse expires header field body
104 112
  */
105 113
 int parse_expires(struct hdr_field* _h)
... ...
@@ -129,7 +137,7 @@ int parse_expires(struct hdr_field* _h)
129 137
 }
130 138
 
131 139
 
132
-/*
140
+/*! \brief
133 141
  * Free all memory associated with exp_body_t
134 142
  */
135 143
 void free_expires(exp_body_t** _e)
... ...
@@ -139,7 +147,7 @@ void free_expires(exp_body_t** _e)
139 147
 }
140 148
 
141 149
 
142
-/*
150
+/*! \brief
143 151
  * Print exp_body_t content, for debugging only
144 152
  */
145 153
 void print_expires(exp_body_t* _e)
... ...
@@ -12,11 +12,6 @@
12 12
  * the Free Software Foundation; either version 2 of the License, or
13 13
  * (at your option) any later version
14 14
  *
15
- * For a license to use the ser software under conditions
16
- * other than those described here, or to purchase support for this
17
- * software, please contact iptel.org by e-mail at the following addresses:
18
- *    info@iptel.org
19
- *
20 15
  * ser is distributed in the hope that it will be useful,
21 16
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 17
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -27,6 +22,13 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file
26
+ * \brief Parser :: Expires header field body parser
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
31
+
30 32
 
31 33
 #ifndef PARSE_EXPIRES_H
32 34
 #define PARSE_EXPIRES_H
... ...
@@ -36,25 +38,25 @@
36 38
 
37 39
 
38 40
 typedef struct exp_body {
39
-	str text;            /* Original text representation */
40
-	unsigned char valid; /* Was parsing successful ? */
41
-	unsigned int val;    /* Parsed value */
41
+	str text;            /*!< Original text representation */
42
+	unsigned char valid; /*!< Was parsing successful ? */
43
+	unsigned int val;    /*!< Parsed value */
42 44
 } exp_body_t;
43 45
 
44 46
 
45
-/*
47
+/*! \brief
46 48
  * Parse expires header field body
47 49
  */
48 50
 int parse_expires(struct hdr_field* _h);
49 51
 
50 52
 
51
-/*
53
+/*! \brief
52 54
  * Free all memory associated with exp_body_t
53 55
  */
54 56
 void free_expires(exp_body_t** _e);
55 57
 
56 58
 
57
-/*
59
+/*! \brief
58 60
  * Print exp_body_t content, for debugging only
59 61
  */
60 62
 void print_expires(exp_body_t* _e);
... ...
@@ -34,6 +34,12 @@
34 34
  * 2003-04-26 ZSW (jiri)
35 35
  */
36 36
 
37
+/*! \file
38
+ * \brief Parser :: SIP first line parsing automaton
39
+ *
40
+ * \ingroup parser
41
+ */
42
+
37 43
 
38 44
 #include "../comp_defs.h"
39 45
 #include "../dprint.h"
... ...
@@ -25,6 +25,11 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: SIP first line parsing automaton
30
+ *
31
+ * \ingroup parser
32
+ */
28 33
 
29 34
 #ifndef PARSE_FLINE_H
30 35
 #define PARSE_FLINE_H
... ...
@@ -66,20 +71,20 @@
66 71
 #define PUBLISH_LEN 7
67 72
 
68 73
 struct msg_start {
69
-	int type;					/* Type of the Message - Request/Response */
70
-	int len; 					/* length including delimiter */
74
+	int type;					/*!< Type of the Message - Request/Response */
75
+	int len; 					/*!< length including delimiter */
71 76
 	union {
72 77
 		struct {
73
-			str method;       /* Method string */
74
-			str uri;          /* Request URI */
75
-			str version;      /* SIP version */
78
+			str method;       /*!< Method string */
79
+			str uri;          /*!< Request URI */
80
+			str version;      /*!< SIP version */
76 81
 			int method_value;
77 82
 		} request;
78 83
 		struct {
79
-			str version;      /* SIP version */
80
-			str status;       /* Reply status */
81
-			str reason;       /* Reply reason phrase */
82
-			unsigned int /* statusclass,*/ statuscode;
84
+			str version;      /*!< SIP version */
85
+			str status;       /*!< Reply status */
86
+			str reason;       /*!< Reply reason phrase */
87
+			unsigned int /*!< statusclass,*/ statuscode;
83 88
 		} reply;
84 89
 	}u;
85 90
 };
... ...
@@ -25,6 +25,11 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: SIP From header parsing
30
+ *
31
+ * \ingroup parser
32
+ */
28 33
 
29 34
 #include "parse_from.h"
30 35
 #include "parse_to.h"
... ...
@@ -35,8 +40,10 @@
35 40
 #include "../ut.h"
36 41
 #include "../mem/mem.h"
37 42
 
38
-/*
39
- * This method is used to parse the from header. It was decided not to parse
43
+/*! \brief
44
+ * This method is used to parse the from header.
45
+ *
46
+ * \note It was decided not to parse
40 47
  * anything in core that is not *needed* so this method gets called by 
41 48
  * rad_acc module and any other modules that needs the FROM header.
42 49
  *
... ...
@@ -10,11 +10,6 @@
10 10
  * the Free Software Foundation; either version 2 of the License, or
11 11
  * (at your option) any later version
12 12
  *
13
- * For a license to use the ser software under conditions
14
- * other than those described here, or to purchase support for this
15
- * software, please contact iptel.org by e-mail at the following addresses:
16
- *    info@iptel.org
17
- *
18 13
  * ser is distributed in the hope that it will be useful,
19 14
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 15
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -25,6 +20,12 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: SIP From header parsing
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
28 29
 
29 30
 #ifndef _PARSE_FROM_H
30 31
 #define _PARSE_FROM_H