Browse code

Doxygen changes

oej authored on 25/10/2009 18:30:31
Showing 35 changed files
... ...
@@ -44,7 +44,8 @@ struct mime_type {
44 44
 /*! \name MimeTypes
45 45
  * Mimes types/subtypes that are recognized
46 46
  */
47
-/*! { */
47
+/*@{ */
48
+
48 49
 #define TYPE_TEXT            1
49 50
 #define TYPE_MESSAGE         2
50 51
 #define TYPE_APPLICATION     3
... ...
@@ -69,7 +70,7 @@ struct mime_type {
69 70
 #define SUBTYPE_ALL          0xfe
70 71
 #define SUBTYPE_UNKNOWN      0xff
71 72
 
72
-/*! } */
73
+/*@} */
73 74
 
74 75
 /*! \brief taken from PA module - will be useful here */
75 76
 #define MIMETYPE(x_,y_) ((TYPE_##x_ << 16) | (SUBTYPE_##y_))
... ...
@@ -35,6 +35,11 @@
35 35
  * 2007-07-27 added support for Retry-After (andrei)
36 36
  */
37 37
 
38
+/*! \file
39
+ * \brief Parser :: Fast 32-bit Header Field Name Parser
40
+ *
41
+ * \ingroup parser
42
+ */
38 43
 
39 44
 #include "../comp_defs.h"
40 45
 #include "parse_hname2.h"
... ...
@@ -44,7 +49,7 @@
44 49
 #define LOWER_BYTE(b) ((b) | 0x20)
45 50
 #define LOWER_DWORD(d) ((d) | 0x20202020)
46 51
 
47
-/*
52
+/*! \brief
48 53
  * Skip all white-chars and return position of the first
49 54
  * non-white char
50 55
  */
... ...
@@ -59,9 +64,10 @@ static inline char* skip_ws(char* p, unsigned int size)
59 64
 	return p;
60 65
 }
61 66
 
62
-/*
67
+/*! \name 
63 68
  * Parser macros
64 69
  */
70
+/*! { */
65 71
 #include "case_via.h"      /* Via */
66 72
 #include "case_from.h"     /* From */
67 73
 #include "case_to.h"       /* To */
... ...
@@ -101,6 +107,7 @@ static inline char* skip_ws(char* p, unsigned int size)
101 107
 #include "case_path.h"     /* Path */
102 108
 #include "case_priv.h"
103 109
 
110
+/*! } */
104 111
 
105 112
 #define READ(val) \
106 113
 (*(val + 0) + (*(val + 1) << 8) + (*(val + 2) << 16) + (*(val + 3) << 24))
... ...
@@ -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,11 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file
26
+ * \brief Parser :: Fast 32-bit Header Field Name Parser
27
+ *
28
+ * \ingroup parser
29
+ */
30 30
 
31 31
 #ifndef PARSE_HNAME2_H
32 32
 #define PARSE_HNAME2_H
... ...
@@ -34,7 +34,7 @@
34 34
 #include "hf.h"
35 35
 
36 36
 
37
-/*
37
+/*! \brief
38 38
  * Fast 32-bit header field name parser
39 39
  */
40 40
 char* parse_hname2(char* begin, char* end, struct hdr_field* hdr);
... ...
@@ -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 :: Parse domain/hostname and port argument
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+
28 30
 #ifdef _OBSOLETED
29 31
 
30 32
 #include "parse_hostport.h"
... ...
@@ -25,6 +25,12 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse domain/hostname and port argument
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
28 34
 
29 35
 #ifndef PARSE_HOSTPORT_H
30 36
 #define PARSE_HOSTPORT_H
... ...
@@ -25,6 +25,12 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse Identity header field
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
28 34
 
29 35
 #include <string.h>
30 36
 #include "parse_identity.h"
... ...
@@ -50,7 +56,7 @@ inline static int isendofhash (char* p, char* end)
50 56
 }
51 57
 
52 58
 
53
-/*
59
+/*! \brief
54 60
  * If the value of Identity header contains any LWS then we've to create
55 61
  * a new buffer and move there the LWSless part
56 62
  */
... ...
@@ -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 :: Parse Identity header field
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
28 29
 
29 30
 #ifndef PARSE_IDENTITY
30 31
 #define PARSE_IDENTITY
... ...
@@ -33,24 +34,28 @@
33 34
 #include "msg_parser.h"
34 35
 
35 36
 struct identity_body{
36
-	int error;  		/* Error code */
37
-	int ballocated;  	/* Does hash point to an allocated area */
37
+	int error;  		/*!< Error code */
38
+	int ballocated;  	/*!< Does hash point to an allocated area */
38 39
 	str hash;
39 40
 };
40 41
 
41 42
 
42
-/* casting macro for accessing IDENTITY body */
43
+/*! \brief casting macro for accessing IDENTITY body */
43 44
 #define get_identity(p_msg) ((struct identity_body*)(p_msg)->identity->parsed)
44 45
 
45 46
 
46
-/*
47
+/*! \brief
47 48
  * Parse Identity header field
48 49
  */
49 50
 void parse_identity(char *buf, char *end, struct identity_body *ib);
51
+
52
+/*! \brief
53
+ * Parse Identity header field
54
+ */
50 55
 int parse_identity_header(struct sip_msg *msg);
51 56
 
52 57
 
53
-/*
58
+/*! \brief
54 59
  * Free all associated memory
55 60
  */
56 61
 void free_identity(struct identity_body *ib);
... ...
@@ -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 :: Parse Identity-info header field
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
28 29
 #include <stdlib.h>
29 30
 #include <string.h>
30 31
 #include <ctype.h>
... ...
@@ -34,6 +35,7 @@
34 35
 #include "parser_f.h"  /* eat_space_end and so on */
35 36
 
36 37
 
38
+/*! \brief Parse Identity-info header field */
37 39
 void parse_identityinfo(char *buffer, char *end, struct identityinfo_body *ii_b)
38 40
 {
39 41
 	int status = II_START;
... ...
@@ -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,11 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Parse Identity-info header field
25
+ *
26
+ * \ingroup parser
27
+ */
28 28
 
29 29
 #ifndef PARSE_IDENTITYNFO
30 30
 #define PARSE_IDENTITYNFO
... ...
@@ -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,13 +20,19 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Parse Methods
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
28 29
 #include <strings.h>
29 30
 #include "../dprint.h"
30 31
 #include "../trim.h"
31 32
 #include "parse_methods.h"
32 33
 
33 34
 
34
-/*
35
+/*! \brief
35 36
  * Check if argument is valid RFC3261 token character.
36 37
  */
37 38
 static int token_char(char _c)
... ...
@@ -46,10 +47,11 @@ static int token_char(char _c)
46 47
 
47 48
 
48 49
 
49
-/** Parse a string containing a method.
50
+/*! \brief Parse a string containing a method.
51
+ *
50 52
  * Parse a method pointed by s & assign its enum bit to method. The string
51 53
  * _must_ contain _only_ the method (without trailing or heading whitespace).
52
- * @return 0 on success, -1 on error
54
+ * \return 0 on success, -1 on error
53 55
  */
54 56
 int parse_method_name(str* s, enum request_method* method)
55 57
  {
... ...
@@ -159,14 +161,14 @@ int parse_method_name(str* s, enum request_method* method)
159 161
 		default:
160 162
 			break;
161 163
 	}
162
-/* unknown method */
164
+	/* unknown method */
163 165
 	*method = METHOD_OTHER;
164 166
 	return 0;
165 167
 }
166 168
 
167 169
 
168 170
 
169
- /*
171
+ /*! \brief
170 172
   * Parse a method pointed by _next, assign its enum bit to _method, and update
171 173
   * _next past the method. Returns 1 if parse succeeded and 0 otherwise.
172 174
   */
... ...
@@ -352,7 +354,7 @@ found:
352 354
  }
353 355
  
354 356
  
355
- /* 
357
+ /*! \brief
356 358
   * Parse comma separated list of methods pointed by _body and assign their
357 359
   * enum bits to _methods.  Returns 0 on success and -1 on failure.
358 360
   */
... ...
@@ -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 Methods
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
34
+
28 35
 #ifndef PARSE_METHODS_H
29 36
 #define PARSE_METHODS_H
30 37
 
... ...
@@ -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,12 @@
30 25
  * 2003-04-26 ZSW (jiri)
31 26
  */
32 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse name-addr part
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
33 34
 #include <string.h>
34 35
 #include "../dprint.h"
35 36
 #include "parse_nameaddr.h"
... ...
@@ -37,7 +38,7 @@
37 38
 #include "../ut.h"
38 39
 
39 40
 
40
-/*
41
+/*! \brief
41 42
  * Parse name-addr part, the given string can be longer,
42 43
  * parsing will stop when closing > is found
43 44
  */
... ...
@@ -73,7 +74,7 @@ int parse_nameaddr(str* _s, name_addr_t* _a)
73 74
 }
74 75
 
75 76
 
76
-/*
77
+/*! \brief
77 78
  * Print a name-addr structure, just for debugging
78 79
  */
79 80
 void print_nameaddr(FILE* _o, name_addr_t* _a)
... ...
@@ -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
... ...
@@ -29,31 +24,37 @@
29 24
  * 2003-03-24 Created by janakj
30 25
  */
31 26
 
27
+/*! \file
28
+ * \brief Parser :: Parse name-addr part
29
+ *
30
+ * \ingroup parser
31
+ */
32
+
32 33
 #ifndef PARSE_NAMEADDR_H
33 34
 #define PARSE_NAMEADDR_H
34 35
 
35 36
 #include <stdio.h>
36 37
 #include "../str.h"
37 38
 
38
-/*
39
+/*! \brief
39 40
  * Name-addr structure, see RFC3261 for more details
40 41
  */
41 42
 typedef struct name_addr {
42
-	str name;   /* Display name part */
43
-	str uri;    /* Uri part without surrounding <> */
44
-	int len;    /* Total length of the field (including all
43
+	str name;   /*!< Display name part */
44
+	str uri;    /*!< Uri part without surrounding <> */
45
+	int len;    /*!< Total length of the field (including all
45 46
 		    * whitechars present in the parsed message */
46 47
 } name_addr_t;
47 48
 
48 49
 
49
-/*
50
+/*! \brief
50 51
  * Parse name-addr part, the given string can be longer,
51 52
  * parsing will stop when closing > is found
52 53
  */
53 54
 int parse_nameaddr(str* _s, name_addr_t* _a);
54 55
 
55 56
 
56
-/*
57
+/*! \brief
57 58
  * Print a name-addr structure, just for debugging
58 59
  */
59 60
 void print_nameaddr(FILE* _o, name_addr_t* _a);
... ...
@@ -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
... ...
@@ -33,6 +28,12 @@
33 28
  * 2003-04-07 URI class added (janakj)
34 29
  */
35 30
 
31
+/*! \file
32
+ * \brief Parser :: Generic Parameter Parser
33
+ *
34
+ * \ingroup parser
35
+ */
36
+
36 37
 #include <string.h>
37 38
 #include "../str.h"
38 39
 #include "../ut.h"
... ...
@@ -103,7 +104,7 @@ static inline void parse_event_dialog_class(param_hooks_t* h, param_t* p)
103 104
 }
104 105
 
105 106
 
106
-/*
107
+/*! \brief
107 108
  * Try to find out parameter name, recognized parameters
108 109
  * are q, expires and methods
109 110
  */
... ...
@@ -164,7 +165,7 @@ static inline void parse_contact_class(param_hooks_t* _h, param_t* _p)
164 165
 }
165 166
 
166 167
 
167
-/*
168
+/*! \brief
168 169
  * Try to find out parameter name, recognized parameters
169 170
  * are transport, lr, r2, maddr
170 171
  */
... ...
@@ -245,7 +246,7 @@ static inline void parse_uri_class(param_hooks_t* _h, param_t* _p)
245 246
 }
246 247
 
247 248
 
248
-/*
249
+/*! \brief
249 250
  * Parse quoted string in a parameter body
250 251
  * return the string without quotes in _r
251 252
  * parameter and update _s to point behind the
... ...
@@ -292,7 +293,7 @@ static inline int parse_quoted_param(str* _s, str* _r)
292 293
 }
293 294
 
294 295
 
295
-/*
296
+/*! \brief
296 297
  * Parse unquoted token in a parameter body
297 298
  * let _r point to the token and update _s
298 299
  * to point right behind the token
... ...
@@ -354,7 +355,7 @@ static inline int parse_token_param(str* _s, str* _r)
354 355
 }
355 356
 
356 357
 
357
-/*
358
+/*! \brief
358 359
  * Parse a parameter name
359 360
  */
360 361
 static inline void parse_param_name(str* _s, pclass_t _c, param_hooks_t* _h, param_t* _p)
... ...
@@ -397,7 +398,7 @@ static inline void parse_param_name(str* _s, pclass_t _c, param_hooks_t* _h, par
397 398
 
398 399
 
399 400
 
400
-/*
401
+/*! \brief
401 402
  * Parse body of a parameter. It can be quoted string or
402 403
  * a single token.
403 404
  */
... ...
@@ -419,7 +420,7 @@ static inline int parse_param_body(str* _s, param_t* _c)
419 420
 }
420 421
 
421 422
 
422
-/**
423
+/*!  \brief
423 424
  * Only parse one parameter
424 425
  * Returns:
425 426
  * 	t: out parameter
... ...
@@ -491,13 +492,14 @@ error:
491 492
 
492 493
 
493 494
 
494
-/*
495
+/*! \brief
495 496
  * Parse parameters
496
- * _s is string containing parameters, it will be updated to point behind the parameters
497
- * _c is class of parameters
498
- * _h is pointer to structure that will be filled with pointer to well known parameters
499
- * linked list of parsed parameters will be stored in
500
- * the variable _p is pointing to
497
+ *  \param _s is string containing parameters, it will be updated to point behind the parameters
498
+ *  \param _c is class of parameters
499
+ *  \param _h is pointer to structure that will be filled with pointer to well known parameters
500
+ *  \param the variable _p is pointing to
501
+ * linked list of parsed parameters will be stored
502
+ *
501 503
  * The function returns 0 on success and negative number
502 504
  * on an error
503 505
  */
... ...
@@ -548,7 +550,7 @@ int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p)
548 550
 }
549 551
 
550 552
 
551
-/*
553
+/*! \brief
552 554
  * Free linked list of parameters
553 555
  */
554 556
 static inline void do_free_params(param_t* _p, int _shm)
... ...
@@ -564,7 +566,7 @@ static inline void do_free_params(param_t* _p, int _shm)
564 566
 }
565 567
 
566 568
 
567
-/*
569
+/*! \brief
568 570
  * Free linked list of parameters
569 571
  */
570 572
 void free_params(param_t* _p)
... ...
@@ -573,7 +575,7 @@ void free_params(param_t* _p)
573 575
 }
574 576
 
575 577
 
576
-/*
578
+/*! \brief
577 579
  * Free linked list of parameters
578 580
  */
579 581
 void shm_free_params(param_t* _p)
... ...
@@ -582,7 +584,7 @@ void shm_free_params(param_t* _p)
582 584
 }
583 585
 
584 586
 
585
-/*
587
+/*! \brief
586 588
  * Print a parameter structure, just for debugging
587 589
  */
588 590
 static inline void print_param(FILE* _o, param_t* _p)
... ...
@@ -622,7 +624,7 @@ static inline void print_param(FILE* _o, param_t* _p)
622 624
 }
623 625
 
624 626
 
625
-/*
627
+/*! \brief
626 628
  * Print linked list of parameters, just for debugging
627 629
  */
628 630
 void print_params(FILE* _o, param_t* _p)
... ...
@@ -637,7 +639,7 @@ void print_params(FILE* _o, param_t* _p)
637 639
 }
638 640
 
639 641
 
640
-/*
642
+/*! \brief
641 643
  * Duplicate linked list of parameters
642 644
  */
643 645
 static inline int do_duplicate_params(param_t** _n, param_t* _p, int _shm)
... ...
@@ -679,7 +681,7 @@ static inline int do_duplicate_params(param_t** _n, param_t* _p, int _shm)
679 681
 }
680 682
 
681 683
 
682
-/*
684
+/*! \brief
683 685
  * Duplicate linked list of parameters
684 686
  */
685 687
 int duplicate_params(param_t** _n, param_t* _p)
... ...
@@ -688,7 +690,7 @@ int duplicate_params(param_t** _n, param_t* _p)
688 690
 }
689 691
 
690 692
 
691
-/*
693
+/*! \brief
692 694
  * Duplicate linked list of parameters
693 695
  */
694 696
 int shm_duplicate_params(param_t** _n, param_t* _p)
... ...
@@ -33,85 +33,92 @@
33 33
  * 2003-04-07 URI class added (janakj)
34 34
  */
35 35
 
36
+/*! \file
37
+ * \brief Parser :: Generic Parameter Parser
38
+ *
39
+ * \ingroup parser
40
+ */
41
+
42
+
36 43
 #ifndef PARSE_PARAM_H
37 44
 #define PARSE_PARAM_H
38 45
 
39 46
 #include <stdio.h>
40 47
 
41 48
 
42
-/*
49
+/*! \brief
43 50
  * Supported types of parameters
44 51
  */
45 52
 typedef enum ptype {
46
-	P_OTHER = 0, /* Unknown parameter */
47
-	P_Q,         /* Contact: q parameter */
48
-	P_EXPIRES,   /* Contact: expires parameter */
49
-	P_METHODS,   /* Contact: methods parameter */
50
-	P_RECEIVED,  /* Contact: received parameter */
51
-	P_TRANSPORT, /* URI: transport parameter */
52
-	P_LR,        /* URI: lr parameter */
53
-	P_R2,        /* URI: r2 parameter (ser specific) */
54
-	P_MADDR,     /* URI: maddr parameter */
55
-	P_TTL,       /* URI: ttl parameter */
56
-	P_DSTIP,     /* URI: dstip parameter */
57
-	P_DSTPORT,   /* URi: dstport parameter */
58
-	P_INSTANCE,  /* Contact: sip.instance parameter */
59
-	P_FTAG,      /* URI: ftag parameter */
60
-	P_CALL_ID,   /* Dialog event package: call-id */
61
-	P_FROM_TAG,  /* Dialog event package: from-tag */
62
-	P_TO_TAG,    /* Dialog event package: to-tag */
63
-	P_ISD,       /* Dialog event package: include-session-description */
64
-	P_SLA        /* Dialog event package: sla */
53
+	P_OTHER = 0, /*!< Unknown parameter */
54
+	P_Q,         /*!< Contact: q parameter */
55
+	P_EXPIRES,   /*!< Contact: expires parameter */
56
+	P_METHODS,   /*!< Contact: methods parameter */
57
+	P_RECEIVED,  /*!< Contact: received parameter */
58
+	P_TRANSPORT, /*!< URI: transport parameter */
59
+	P_LR,        /*!< URI: lr parameter */
60
+	P_R2,        /*!< URI: r2 parameter (ser specific) */
61
+	P_MADDR,     /*!< URI: maddr parameter */
62
+	P_TTL,       /*!< URI: ttl parameter */
63
+	P_DSTIP,     /*!< URI: dstip parameter */
64
+	P_DSTPORT,   /*!< URi: dstport parameter */
65
+	P_INSTANCE,  /*!< Contact: sip.instance parameter */
66
+	P_FTAG,      /*!< URI: ftag parameter */
67
+	P_CALL_ID,   /*!< Dialog event package: call-id */
68
+	P_FROM_TAG,  /*!< Dialog event package: from-tag */
69
+	P_TO_TAG,    /*!< Dialog event package: to-tag */
70
+	P_ISD,       /*!< Dialog event package: include-session-description */
71
+	P_SLA        /*!< Dialog event package: sla */
65 72
 } ptype_t;
66 73
 
67 74
 
68
-/*
75
+/*! \brief
69 76
  * Class of parameters
70 77
  */
71 78
 typedef enum pclass {
72
-	CLASS_ANY = 0,      /* Any parameters, well-known hooks will be not used */
73
-	CLASS_CONTACT,      /* Contact parameters */
74
-	CLASS_URI,          /* URI parameters */
75
-	CLASS_EVENT_DIALOG  /* Event dialog parameters */
79
+	CLASS_ANY = 0,      /*!< Any parameters, well-known hooks will be not used */
80
+	CLASS_CONTACT,      /*!< Contact parameters */
81
+	CLASS_URI,          /*!< URI parameters */
82
+	CLASS_EVENT_DIALOG  /*!< Event dialog parameters */
76 83
 } pclass_t;
77 84
 
78 85
 
79
-/*
86
+/*! \brief
80 87
  * Structure representing a parameter
81 88
  */
82 89
 typedef struct param {
83
-	ptype_t type;         /* Type of the parameter */
84
-	str name;             /* Parameter name */
85
-	str body;             /* Parameter body */
86
-	int len;              /* Total length of the parameter including = and quotes */
87
-	struct param* next;   /* Next parameter in the list */
90
+	ptype_t type;         /*!< Type of the parameter */
91
+	str name;             /*!< Parameter name */
92
+	str body;             /*!< Parameter body */
93
+	int len;              /*!< Total length of the parameter including = and quotes */
94
+	struct param* next;   /*!< Next parameter in the list */
88 95
 } param_t;
89 96
 
90 97
 
91
-/*
98
+/*! \brief
92 99
  * Hooks to well known parameters for contact class of parameters
93 100
  */
94 101
 struct contact_hooks {
95
-	struct param* expires;  /* expires parameter */
96
-	struct param* q;        /* q parameter */
97
-	struct param* methods;  /* methods parameter */
98
-	struct param* received; /* received parameter */
99
-	struct param* instance; /* sip.instance parameter */
102
+	struct param* expires;  /*!< expires parameter */
103
+	struct param* q;        /*!< q parameter */
104
+	struct param* methods;  /*!< methods parameter */
105
+	struct param* received; /*!< received parameter */
106
+	struct param* instance; /*!< sip.instance parameter */
100 107
 };
101 108
 
102 109
 
103
-/*
110
+/*! \brief
104 111
  * Hooks to well known parameter for URI class of parameters
105 112
  */
106 113
 struct uri_hooks {
107
-	struct param* transport; /* transport parameter */
108
-	struct param* lr;        /* lr parameter */
109
-	struct param* r2;        /* r2 parameter */
110
-	struct param* maddr;     /* maddr parameter */
111
-	struct param* ttl;       /* ttl parameter */
112
-	struct param* dstip;     /* Destination IP */
113
-	struct param* dstport;   /* Destination port */
114
-	struct param* ftag;      /* From tag in the original request */
114
+	struct param* transport; /*!< transport parameter */
115
+	struct param* lr;        /*!< lr parameter */
116
+	struct param* r2;        /*!< r2 parameter */
117
+	struct param* maddr;     /*!< maddr parameter */
118
+	struct param* ttl;       /*!< ttl parameter */
119
+	struct param* dstip;     /*!< Destination IP */
120
+	struct param* dstport;   /*!< Destination port */
121
+	struct param* ftag;      /*!< From tag in the original request */
115 122
 };
116 123
 
117 124
 
... ...
@@ -123,16 +130,16 @@ struct event_dialog_hooks {
123 130
 	struct param* sla;
124 131
 };
125 132
 
126
-/*
133
+/*! \brief
127 134
  * Union of hooks structures for all classes
128 135
  */
129 136
 typedef union param_hooks {
130
-	struct contact_hooks contact; /* Contact hooks */
131
-	struct uri_hooks uri;         /* URI hooks */
137
+	struct contact_hooks contact; /*!< Contact hooks */
138
+	struct uri_hooks uri;         /*!< URI hooks */
132 139
 	struct event_dialog_hooks event_dialog;
133 140
 } param_hooks_t;
134 141
 
135
-/**
142
+/*! \brief
136 143
  * Only parse one parameter
137 144
  * @Return:
138 145
  * 	t: out parameter
... ...
@@ -143,44 +150,44 @@ typedef union param_hooks {
143 150
 inline int parse_param(str *_s, pclass_t _c, param_hooks_t *_h, param_t *t);
144 151
 
145 152
 
146
-/*
153
+/*! \brief
147 154
  * Parse parameters
148
- * _s is string containing parameters
149
- * _c is class of parameters
150
- * _h is pointer to structure that will be filled with pointer to well known parameters
155
+ *  \param _s is string containing parameters
156
+ *  \param _c is class of parameters
157
+ *  \param _h is pointer to structure that will be filled with pointer to well known parameters
151 158
  * linked list of parsed parameters will be stored in
152 159
  * the variable _p is pointing to
153
- * The function returns 0 on success and negative number
160
+ * \return The function returns 0 on success and negative number
154 161
  * on an error
155 162
  */
156 163
 int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p);
157 164
 
158 165
 
159
-/*
166
+/*! \brief
160 167
  * Free linked list of parameters
161 168
  */
162 169
 void free_params(param_t* _p);
163 170
 
164 171
 
165
-/*
172
+/*! \brief
166 173
  * Free linked list of parameters from shared memory
167 174
  */
168 175
 void shm_free_params(param_t* _p);
169 176
 
170 177
 
171
-/*
178
+/*! \brief
172 179
  * Print linked list of parameters, just for debugging
173 180
  */
174 181
 void print_params(FILE* _o, param_t* _p);
175 182
 
176 183
 
177
-/*
184
+/*! \brief
178 185
  * Duplicate linked list of parameters
179 186
  */
180 187
 int duplicate_params(param_t** _n, param_t* _p);
181 188
 
182 189
 
183
-/*
190
+/*! \brief
184 191
  * Duplicate linked list of parameters
185 192
  */
186 193
 int shm_duplicate_params(param_t** _n, param_t* _p);
... ...
@@ -8,11 +8,6 @@
8 8
  * the Free Software Foundation; either version 2 of the License, or
9 9
  * (at your option) any later version
10 10
  *
11
- * For a license to use the ser software under conditions
12
- * other than those described here, or to purchase support for this
13
- * software, please contact iptel.org by e-mail at the following addresses:
14
- *    info@iptel.org
15
- *
16 11
  * ser is distributed in the hope that it will be useful,
17 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -22,6 +17,12 @@
22 17
  * along with this program; if not, write to the Free Software 
23 18
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 19
  */
20
+
21
+/*! \file
22
+ * \brief Parser :: Refert-To: header parser
23
+ *
24
+ * \ingroup parser
25
+ */
25 26
  
26 27
 #include "parse_from.h"
27 28
 #include "parse_to.h"
... ...
@@ -33,7 +34,7 @@
33 34
 #include "../mem/mem.h"
34 35
 
35 36
  
36
-/*
37
+/*! \brief
37 38
  * This method is used to parse Refer-To header.
38 39
  *
39 40
  * params: msg : sip msg
... ...
@@ -8,11 +8,6 @@
8 8
  * the Free Software Foundation; either version 2 of the License, or
9 9
  * (at your option) any later version
10 10
  *
11
- * For a license to use the ser software under conditions
12
- * other than those described here, or to purchase support for this
13
- * software, please contact iptel.org by e-mail at the following addresses:
14
- *    info@iptel.org
15
- *
16 11
  * ser is distributed in the hope that it will be useful,
17 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -22,7 +17,12 @@
22 17
  * along with this program; if not, write to the Free Software 
23 18
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 19
  */
25
- 
20
+
21
+/*! \file
22
+ * \brief Parser :: Refert-To: header parser
23
+ *
24
+ * \ingroup parser
25
+ */
26 26
  
27 27
 #ifndef PARSE_REFER_TO_H
28 28
 #define PARSE_REFER_TO_H
... ...
@@ -30,7 +30,7 @@
30 30
 #include "msg_parser.h"
31 31
  
32 32
  
33
-/* casting macro for accessing Refer-To body */
33
+/*! \brief casting macro for accessing Refer-To body */
34 34
 #define get_refer_to(p_msg)  ((struct to_body*)(p_msg)->refer_to->parsed)
35 35
 
36 36
 
... ...
@@ -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
... ...
@@ -29,6 +24,12 @@
29 24
  *  2007-07-27  created by andrei
30 25
  */
31 26
 
27
+/*! \file
28
+ * \brief Parser :: Retry-After: header parser
29
+ *
30
+ * \ingroup parser
31
+ */
32
+ 
32 33
 
33 34
 #include "../comp_defs.h"
34 35
 #include "parse_retry_after.h"
... ...
@@ -37,7 +38,7 @@
37 38
 #include "../dprint.h"
38 39
 #include "../mem/mem.h"
39 40
 
40
-/* Parse the Retry-after header field */
41
+/*! \brief Parse the Retry-after header field */
41 42
 char* parse_retry_after(char *buf, char* end, unsigned* after, int* err)
42 43
 {
43 44
 	char *t;
... ...
@@ -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,11 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Retry-After: header parser
25
+ *
26
+ * \ingroup parser
27
+ */
28 28
 
29 29
 #ifndef _parse_retry_after_h
30 30
 #define _parse_retry_after_h
... ...
@@ -8,11 +8,6 @@
8 8
  * the Free Software Foundation; either version 2 of the License, or
9 9
  * (at your option) any later version
10 10
  *
11
- * For a license to use the ser software under conditions
12
- * other than those described here, or to purchase support for this
13
- * software, please contact iptel.org by e-mail at the following addresses:
14
- *    info@iptel.org
15
- *
16 11
  * ser is distributed in the hope that it will be useful,
17 12
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 13
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
... ...
@@ -22,6 +17,12 @@
22 17
  * along with this program; if not, write to the Free Software 
23 18
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 19
  */
20
+
21
+/*! \file
22
+ * \brief Parser :: Remote-party-id: header parser
23
+ *
24
+ * \ingroup parser
25
+ */
25 26
  
26 27
 #include "parse_from.h"
27 28
 #include "parse_to.h"
... ...
@@ -33,7 +34,7 @@
33 34
 #include "../mem/mem.h"
34 35
 
35 36
  
36
-/*
37
+/*! \brief
37 38
  * This method is used to parse RPID header.
38 39
  *
39 40
  * params: msg : sip msg
... ...
@@ -23,6 +23,11 @@
23 23
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 24
  */
25 25
  
26
+/*! \file
27
+ * \brief Parser :: Remote-party-id: header parser
28
+ *
29
+ * \ingroup parser
30
+ */
26 31
  
27 32
 #ifndef PARSE_RPID_H
28 33
 #define PARSE_RPID_H
... ...
@@ -30,7 +35,7 @@
30 35
 #include "msg_parser.h"
31 36
  
32 37
  
33
-/* casting macro for accessing RPID body */
38
+/*! \brief casting macro for accessing RPID body */
34 39
 #define get_rpid(p_msg)  ((struct to_body*)(p_msg)->rpid->parsed)
35 40
 
36 41
 
... ...
@@ -27,6 +27,12 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file
31
+ * \brief Parser :: Route & Record-Route header field parser
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 /**
31 37
  * History:
32 38
  * --------
... ...
@@ -41,7 +47,7 @@
41 47
 #include "../trim.h"
42 48
 #include "../ut.h"
43 49
 
44
-/*
50
+/*! \brief
45 51
  * Parse Route or Record-Route body
46 52
  */
47 53
 static inline int do_parse_rr_body(char *buf, int len, rr_t **head)
... ...
@@ -144,7 +150,7 @@ static inline int do_parse_rr_body(char *buf, int len, rr_t **head)
144 150
 	return 0;
145 151
 }
146 152
 
147
-/*
153
+/*! \brief
148 154
  * Wrapper to do_parse_rr_body() for external calls
149 155
  */
150 156
 int parse_rr_body(char *buf, int len, rr_t **head)
... ...
@@ -152,7 +158,7 @@ int parse_rr_body(char *buf, int len, rr_t **head)
152 158
 	return do_parse_rr_body(buf, len, head);
153 159
 }
154 160
 
155
-/*
161
+/*! \brief
156 162
  * Parse Route and Record-Route header fields
157 163
  */
158 164
 int parse_rr(struct hdr_field* _h)
... ...
@@ -175,7 +181,7 @@ int parse_rr(struct hdr_field* _h)
175 181
 	return 0;
176 182
 }
177 183
 
178
-/*
184
+/*! \brief
179 185
  * Free list of rrs
180 186
  * _r is head of the list
181 187
  */
... ...
@@ -196,7 +202,7 @@ static inline void do_free_rr(rr_t** _r, int _shm)
196 202
 }
197 203
 
198 204
 
199
-/*
205
+/*! \brief
200 206
  * Free list of rrs
201 207
  * _r is head of the list
202 208
  */
... ...
@@ -207,7 +213,7 @@ void free_rr(rr_t** _r)
207 213
 }
208 214
 
209 215
 
210
-/*
216
+/*! \brief
211 217
  * Free list of rrs
212 218
  * _r is head of the list
213 219
  */
... ...
@@ -218,7 +224,7 @@ void shm_free_rr(rr_t** _r)
218 224
 }
219 225
 
220 226
 
221
-/*
227
+/*! \brief
222 228
  * Print list of RRs, just for debugging
223 229
  */
224 230
 void print_rr(FILE* _o, rr_t* _r)
... ...
@@ -241,7 +247,7 @@ void print_rr(FILE* _o, rr_t* _r)
241 247
 }
242 248
 
243 249
 
244
-/*
250
+/*! \brief
245 251
  * Translate all pointers in the structure and also
246 252
  * in all parameters in the list
247 253
  */
... ...
@@ -260,7 +266,7 @@ static inline void xlate_pointers(rr_t* _orig, rr_t* _r)
260 266
 }
261 267
 
262 268
 
263
-/*
269
+/*! \brief
264 270
  * Duplicate a single rr_t structure using pkg_malloc or shm_malloc
265 271
  */
266 272
 static inline int do_duplicate_rr(rr_t** _new, rr_t* _r, int _shm)
... ...
@@ -321,7 +327,7 @@ static inline int do_duplicate_rr(rr_t** _new, rr_t* _r, int _shm)
321 327
 }
322 328
 
323 329
 
324
-/*
330
+/*! \brief
325 331
  * Duplicate a single rr_t structure using pkg_malloc
326 332
  */
327 333
 int duplicate_rr(rr_t** _new, rr_t* _r)
... ...
@@ -330,7 +336,7 @@ int duplicate_rr(rr_t** _new, rr_t* _r)
330 336
 }
331 337
 
332 338
 
333
-/*
339
+/*! \brief
334 340
  * Duplicate a single rr_t structure using pkg_malloc
335 341
  */
336 342
 int shm_duplicate_rr(rr_t** _new, rr_t* _r)
... ...
@@ -27,6 +27,11 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file
31
+ * \brief Parser :: Route & Record-Route header field parser
32
+ *
33
+ * \ingroup parser
34
+ */
30 35
 
31 36
 #ifndef PARSE_RR_H
32 37
 #define PARSE_RR_H
... ...
@@ -38,15 +43,15 @@
38 43
 #include "hf.h"
39 44
 
40 45
 
41
-/*
46
+/*! \brief
42 47
  * Structure representing a Route & Record-Route HF body
43 48
  */
44 49
 typedef struct rr {
45
-	name_addr_t nameaddr; /* Name-addr part */
46
-	param_t* r2;          /* Hook to r2 parameter */
47
-	param_t* params;      /* Linked list of other parameters */
48
-	int len;              /* Length of the whole route field */
49
-	struct rr* next;      /* Next RR in the list */
50
+	name_addr_t nameaddr; /*!< Name-addr part */
51
+	param_t* r2;          /*!< Hook to r2 parameter */
52
+	param_t* params;      /*!< Linked list of other parameters */
53
+	int len;              /*!< Length of the whole route field */
54
+	struct rr* next;      /*!< Next RR in the list */
50 55
 } rr_t;
51 56
 
52 57
 
... ...
@@ -1,3 +1,9 @@
1
+/*! \file
2
+ * \brief Parser :: Parse if-match header
3
+ *
4
+ * \ingroup parser
5
+ */
6
+
1 7
 #include <string.h>
2 8
 
3 9
 #include "parse_sipifmatch.h"
... ...
@@ -25,8 +31,7 @@ static inline char* skip_token(char* _b, int _l)
25 31
 }
26 32
 
27 33
 
28
-int
29
-etag_parser(char *_s, int _l, str *_e)
34
+int etag_parser(char *_s, int _l, str *_e)
30 35
 {
31 36
         char* end;
32 37
 
... ...
@@ -47,8 +52,7 @@ etag_parser(char *_s, int _l, str *_e)
47 52
 }
48 53
 
49 54
 
50
-int
51
-parse_sipifmatch(struct hdr_field* _h)
55
+int parse_sipifmatch(struct hdr_field* _h)
52 56
 {
53 57
 	str *e;
54 58
 
... ...
@@ -1,3 +1,9 @@
1
+/*! \file
2
+ * \brief Parser :: Parse if-match header
3
+ *
4
+ * \ingroup parser
5
+ */
6
+
1 7
 #ifndef PARSE_SIPIFMATCH_H
2 8
 #define PARSE_SIPIFMATCH_H
3 9
 
... ...
@@ -9,13 +15,13 @@ typedef struct etag {
9 15
 } etag_t;
10 16
 
11 17
 
12
-/*
18
+/*! \brief
13 19
  * Parse Sipifmatch HF body
14 20
  */
15 21
 int parse_sipifmatch(struct hdr_field* _h);
16 22
 
17 23
 
18
-/*
24
+/*! \brief
19 25
  * Release memory
20 26
  */
21 27
 void free_sipifmatch(str** _e);
... ...
@@ -1,3 +1,9 @@
1
+/*! \file
2
+ * \brief Parser :: Parse subscription-state in NOTIFY
3
+ *
4
+ * \ingroup parser
5
+ */
6
+
1 7
 #include "parse_subscription_state.h"
2 8
 #include "../dprint.h"
3 9
 #include "../trim.h"
... ...
@@ -1,3 +1,9 @@
1
+/*! \file
2
+ * \brief Parser :: Parse subscription-state in NOTIFY
3
+ *
4
+ * \ingroup parser
5
+ */
6
+
1 7
 #ifndef __PARSE_SUBSCRIPTION_STATE_H
2 8
 #define __PARSE_SUBSCRIPTION_STATE_H
3 9
 
... ...
@@ -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
... ...
@@ -29,6 +24,11 @@
29 24
  * 2003-04-26 ZSW (jiri)
30 25
  */
31 26
 
27
+/*! \file
28
+ * \brief Parser :: Parse To: header
29
+ *
30
+ * \ingroup parser
31
+ */
32 32
 
33 33
 #include "parse_to.h"
34 34
 #include <stdlib.h>
... ...
@@ -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,14 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/*! \file
24
+ * \brief Parser :: Parse To: header
25
+ *
26
+ * \ingroup parser
27
+ */
28
+
29
+#include "parse_to.h"
30
+
28 31
 
29 32
 #ifndef PARSE_TO
30 33
 #define PARSE_TO
... ...
@@ -37,22 +40,22 @@ enum {
37 40
 };
38 41
 
39 42
 struct to_param{
40
-	int type;              /* Type of parameter */
41
-	str name;              /* Name of parameter */
42
-	str value;             /* Parameter value */
43
-	struct to_param* next; /* Next parameter in the list */
43
+	int type;              /*!< Type of parameter */
44
+	str name;              /*!< Name of parameter */
45
+	str value;             /*!< Parameter value */
46
+	struct to_param* next; /*!< Next parameter in the list */
44 47
 };
45 48
 
46 49
 
47 50
 struct to_body{
48
-	int error;                    /* Error code */
49
-	str body;                     /* The whole header field body */
50
-	str uri;                      /* URI */
51
-	str display;				  /* Display Name */
52
-	str tag_value;                /* Value of tag */
51
+	int error;                    /*!< Error code */
52
+	str body;                     /*!< The whole header field body */
53
+	str uri;                      /*!< URI */
54
+	str display;				  /*!< Display Name */
55
+	str tag_value;                /*!< Value of tag */
53 56
 	struct sip_uri parsed_uri;
54
-	struct to_param *param_lst;   /* Linked list of parameters */
55
-	struct to_param *last_param;  /* Last parameter in the list */
57
+	struct to_param *param_lst;   /*!< Linked list of parameters */
58
+	struct to_param *last_param;  /*!< Last parameter in the list */
56 59
 };
57 60
 
58 61
 
... ...
@@ -60,7 +63,7 @@ struct to_body{
60 63
 #define get_to( p_msg)      ((struct to_body*)(p_msg)->to->parsed)
61 64
 
62 65
 
63
-/*
66
+/*! \brief
64 67
  * To header field parser
65 68
  */
66 69
 char* parse_to(char* buffer, char *end, struct to_body *to_b);
... ...
@@ -41,6 +41,12 @@
41 41
  *
42 42
  */
43 43
 
44
+/** @file
45
+ * @brief Parser :: Parse URI's
46
+ *
47
+ * @ingroup parser
48
+ */
49
+
44 50
 
45 51
 #include "../globals.h"
46 52
 #include "parse_uri.h"
... ...
@@ -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,11 @@
25 20
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 21
  */
27 22
 
23
+/** @file
24
+ * @brief Parser :: Parse URI's
25
+ *
26
+ * @ingroup parser
27
+ */
28 28
 
29 29
 #ifndef PARSE_URI_H
30 30
 #define PARSE_URI_H
... ...
@@ -28,7 +28,11 @@
28 28
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29 29
  */
30 30
 
31
-
31
+/** @file
32
+ * @brief Parser :: Via parsing automation
33
+ *
34
+ * @ingroup parser
35
+ */
32 36
 
33 37
 /* 
34 38
  *  2003-01-21  added rport parsing code, contributed by
... ...
@@ -67,7 +71,7 @@
67 71
 
68 72
 
69 73
 
70
-/* main via states (uri:port ...) */
74
+/** \brief main via states (uri:port ...) */
71 75
 enum {	         
72 76
 	F_HOST, P_HOST,
73 77
 	L_PORT, F_PORT, P_PORT,
... ...
@@ -82,7 +86,7 @@ enum {
82 86
 };
83 87
 
84 88
 
85
-/* first via part state */
89
+/** \brief first via part state */
86 90
 enum {
87 91
 	F_SIP = 100,
88 92
 	SIP1, SIP2, FIN_SIP,
... ...
@@ -96,7 +100,7 @@ enum {
96 100
 };
97 101
 
98 102
 
99
-/* param related states
103
+/** \brief param related states
100 104
  * WARNING: keep in sync with parse_via.h, PARAM_HIDDEN, ...
101 105
  */
102 106
 enum {	
... ...
@@ -25,6 +25,12 @@
25 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/** @file
29
+ * @brief Parser :: Via parsing automation
30
+ *
31
+ * @ingroup parser
32
+ */
33
+
28 34
 /* 
29 35
  *  2003-01-21  added rport parsing code, contributed by
30 36
  *               Maxim Sobolev  <sobomax@FreeBSD.org>
... ...
@@ -32,11 +32,17 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33