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 69
 #define SUBTYPE_ALL          0xfe
70 70
 #define SUBTYPE_UNKNOWN      0xff
71 71
 
72
-/*! } */
72
+/*@} */
73 73
 
74 74
 /*! \brief taken from PA module - will be useful here */
75 75
 #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 44
 #define LOWER_BYTE(b) ((b) | 0x20)
45 45
 #define LOWER_DWORD(d) ((d) | 0x20202020)
46 46
 
47
-/*
47
+/*! \brief
48 48
  * Skip all white-chars and return position of the first
49 49
  * non-white char
50 50
  */
... ...
@@ -59,9 +64,10 @@ static inline char* skip_ws(char* p, unsigned int size)
59 59
 	return p;
60 60
 }
61 61
 
62
-/*
62
+/*! \name 
63 63
  * Parser macros
64 64
  */
65
+/*! { */
65 66
 #include "case_via.h"      /* Via */
66 67
 #include "case_from.h"     /* From */
67 68
 #include "case_to.h"       /* To */
... ...
@@ -101,6 +107,7 @@ static inline char* skip_ws(char* p, unsigned int size)
101 101
 #include "case_path.h"     /* Path */
102 102
 #include "case_priv.h"
103 103
 
104
+/*! } */
104 105
 
105 106
 #define READ(val) \
106 107
 (*(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 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file
31
+ * \brief Parser :: Fast 32-bit Header Field Name Parser
32
+ *
33
+ * \ingroup parser
34
+ */
30 35
 
31 36
 #ifndef PARSE_HNAME2_H
32 37
 #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 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
+
34
+
28 35
 #ifdef _OBSOLETED
29 36
 
30 37
 #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 50
 }
51 51
 
52 52
 
53
-/*
53
+/*! \brief
54 54
  * If the value of Identity header contains any LWS then we've to create
55 55
  * a new buffer and move there the LWSless part
56 56
  */
... ...
@@ -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 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
 #ifndef PARSE_IDENTITY
30 36
 #define PARSE_IDENTITY
... ...
@@ -33,24 +34,28 @@
33 33
 #include "msg_parser.h"
34 34
 
35 35
 struct identity_body{
36
-	int error;  		/* Error code */
37
-	int ballocated;  	/* Does hash point to an allocated area */
36
+	int error;  		/*!< Error code */
37
+	int ballocated;  	/*!< Does hash point to an allocated area */
38 38
 	str hash;
39 39
 };
40 40
 
41 41
 
42
-/* casting macro for accessing IDENTITY body */
42
+/*! \brief casting macro for accessing IDENTITY body */
43 43
 #define get_identity(p_msg) ((struct identity_body*)(p_msg)->identity->parsed)
44 44
 
45 45
 
46
-/*
46
+/*! \brief
47 47
  * Parse Identity header field
48 48
  */
49 49
 void parse_identity(char *buf, char *end, struct identity_body *ib);
50
+
51
+/*! \brief
52
+ * Parse Identity header field
53
+ */
50 54
 int parse_identity_header(struct sip_msg *msg);
51 55
 
52 56
 
53
-/*
57
+/*! \brief
54 58
  * Free all associated memory
55 59
  */
56 60
 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 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse Identity-info header field
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
28 34
 #include <stdlib.h>
29 35
 #include <string.h>
30 36
 #include <ctype.h>
... ...
@@ -34,6 +35,7 @@
34 34
 #include "parser_f.h"  /* eat_space_end and so on */
35 35
 
36 36
 
37
+/*! \brief Parse Identity-info header field */
37 38
 void parse_identityinfo(char *buffer, char *end, struct identityinfo_body *ii_b)
38 39
 {
39 40
 	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 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse Identity-info header field
30
+ *
31
+ * \ingroup parser
32
+ */
28 33
 
29 34
 #ifndef PARSE_IDENTITYNFO
30 35
 #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 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
+
28 34
 #include <strings.h>
29 35
 #include "../dprint.h"
30 36
 #include "../trim.h"
31 37
 #include "parse_methods.h"
32 38
 
33 39
 
34
-/*
40
+/*! \brief
35 41
  * Check if argument is valid RFC3261 token character.
36 42
  */
37 43
 static int token_char(char _c)
... ...
@@ -46,10 +47,11 @@ static int token_char(char _c)
46 46
 
47 47
 
48 48
 
49
-/** Parse a string containing a method.
49
+/*! \brief Parse a string containing a method.
50
+ *
50 51
  * Parse a method pointed by s & assign its enum bit to method. The string
51 52
  * _must_ contain _only_ the method (without trailing or heading whitespace).
52
- * @return 0 on success, -1 on error
53
+ * \return 0 on success, -1 on error
53 54
  */
54 55
 int parse_method_name(str* s, enum request_method* method)
55 56
  {
... ...
@@ -159,14 +161,14 @@ int parse_method_name(str* s, enum request_method* method)
159 159
 		default:
160 160
 			break;
161 161
 	}
162
-/* unknown method */
162
+	/* unknown method */
163 163
 	*method = METHOD_OTHER;
164 164
 	return 0;
165 165
 }
166 166
 
167 167
 
168 168
 
169
- /*
169
+ /*! \brief
170 170
   * Parse a method pointed by _next, assign its enum bit to _method, and update
171 171
   * _next past the method. Returns 1 if parse succeeded and 0 otherwise.
172 172
   */
... ...
@@ -352,7 +354,7 @@ found:
352 352
  }
353 353
  
354 354
  
355
- /* 
355
+ /*! \brief
356 356
   * Parse comma separated list of methods pointed by _body and assign their
357 357
   * enum bits to _methods.  Returns 0 on success and -1 on failure.
358 358
   */
... ...
@@ -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 30
  * 2003-04-26 ZSW (jiri)
31 31
  */
32 32
 
33
+/*! \file
34
+ * \brief Parser :: Parse name-addr part
35
+ *
36
+ * \ingroup parser
37
+ */
38
+
33 39
 #include <string.h>
34 40
 #include "../dprint.h"
35 41
 #include "parse_nameaddr.h"
... ...
@@ -37,7 +38,7 @@
37 37
 #include "../ut.h"
38 38
 
39 39
 
40
-/*
40
+/*! \brief
41 41
  * Parse name-addr part, the given string can be longer,
42 42
  * parsing will stop when closing > is found
43 43
  */
... ...
@@ -73,7 +74,7 @@ int parse_nameaddr(str* _s, name_addr_t* _a)
73 73
 }
74 74
 
75 75
 
76
-/*
76
+/*! \brief
77 77
  * Print a name-addr structure, just for debugging
78 78
  */
79 79
 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 29
  * 2003-03-24 Created by janakj
30 30
  */
31 31
 
32
+/*! \file
33
+ * \brief Parser :: Parse name-addr part
34
+ *
35
+ * \ingroup parser
36
+ */
37
+
32 38
 #ifndef PARSE_NAMEADDR_H
33 39
 #define PARSE_NAMEADDR_H
34 40
 
35 41
 #include <stdio.h>
36 42
 #include "../str.h"
37 43
 
38
-/*
44
+/*! \brief
39 45
  * Name-addr structure, see RFC3261 for more details
40 46
  */
41 47
 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
48
+	str name;   /*!< Display name part */
49
+	str uri;    /*!< Uri part without surrounding <> */
50
+	int len;    /*!< Total length of the field (including all
45 51
 		    * whitechars present in the parsed message */
46 52
 } name_addr_t;
47 53
 
48 54
 
49
-/*
55
+/*! \brief
50 56
  * Parse name-addr part, the given string can be longer,
51 57
  * parsing will stop when closing > is found
52 58
  */
53 59
 int parse_nameaddr(str* _s, name_addr_t* _a);
54 60
 
55 61
 
56
-/*
62
+/*! \brief
57 63
  * Print a name-addr structure, just for debugging
58 64
  */
59 65
 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 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
+
36 42
 #include <string.h>
37 43
 #include "../str.h"
38 44
 #include "../ut.h"
... ...
@@ -103,7 +104,7 @@ static inline void parse_event_dialog_class(param_hooks_t* h, param_t* p)
103 103
 }
104 104
 
105 105
 
106
-/*
106
+/*! \brief
107 107
  * Try to find out parameter name, recognized parameters
108 108
  * are q, expires and methods
109 109
  */
... ...
@@ -164,7 +165,7 @@ static inline void parse_contact_class(param_hooks_t* _h, param_t* _p)
164 164
 }
165 165
 
166 166
 
167
-/*
167
+/*! \brief
168 168
  * Try to find out parameter name, recognized parameters
169 169
  * are transport, lr, r2, maddr
170 170
  */
... ...
@@ -245,7 +246,7 @@ static inline void parse_uri_class(param_hooks_t* _h, param_t* _p)
245 245
 }
246 246
 
247 247
 
248
-/*
248
+/*! \brief
249 249
  * Parse quoted string in a parameter body
250 250
  * return the string without quotes in _r
251 251
  * parameter and update _s to point behind the
... ...
@@ -292,7 +293,7 @@ static inline int parse_quoted_param(str* _s, str* _r)
292 292
 }
293 293
 
294 294
 
295
-/*
295
+/*! \brief
296 296
  * Parse unquoted token in a parameter body
297 297
  * let _r point to the token and update _s
298 298
  * to point right behind the token
... ...
@@ -354,7 +355,7 @@ static inline int parse_token_param(str* _s, str* _r)
354 354
 }
355 355
 
356 356
 
357
-/*
357
+/*! \brief
358 358
  * Parse a parameter name
359 359
  */
360 360
 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 397
 
398 398
 
399 399
 
400
-/*
400
+/*! \brief
401 401
  * Parse body of a parameter. It can be quoted string or
402 402
  * a single token.
403 403
  */
... ...
@@ -419,7 +420,7 @@ static inline int parse_param_body(str* _s, param_t* _c)
419 419
 }
420 420
 
421 421
 
422
-/**
422
+/*!  \brief
423 423
  * Only parse one parameter
424 424
  * Returns:
425 425
  * 	t: out parameter
... ...
@@ -491,13 +492,14 @@ error:
491 491
 
492 492
 
493 493
 
494
-/*
494
+/*! \brief
495 495
  * 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
496
+ *  \param _s is string containing parameters, it will be updated to point behind the parameters
497
+ *  \param _c is class of parameters
498
+ *  \param _h is pointer to structure that will be filled with pointer to well known parameters
499
+ *  \param the variable _p is pointing to
500
+ * linked list of parsed parameters will be stored
501
+ *
501 502
  * The function returns 0 on success and negative number
502 503
  * on an error
503 504
  */
... ...
@@ -548,7 +550,7 @@ int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p)
548 548
 }
549 549
 
550 550
 
551
-/*
551
+/*! \brief
552 552
  * Free linked list of parameters
553 553
  */
554 554
 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 564
 }
565 565
 
566 566
 
567
-/*
567
+/*! \brief
568 568
  * Free linked list of parameters
569 569
  */
570 570
 void free_params(param_t* _p)
... ...
@@ -573,7 +575,7 @@ void free_params(param_t* _p)
573 573
 }
574 574
 
575 575
 
576
-/*
576
+/*! \brief
577 577
  * Free linked list of parameters
578 578
  */
579 579
 void shm_free_params(param_t* _p)
... ...
@@ -582,7 +584,7 @@ void shm_free_params(param_t* _p)
582 582
 }
583 583
 
584 584
 
585
-/*
585
+/*! \brief
586 586
  * Print a parameter structure, just for debugging
587 587
  */
588 588
 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 622
 }
623 623
 
624 624
 
625
-/*
625
+/*! \brief
626 626
  * Print linked list of parameters, just for debugging
627 627
  */
628 628
 void print_params(FILE* _o, param_t* _p)
... ...
@@ -637,7 +639,7 @@ void print_params(FILE* _o, param_t* _p)
637 637
 }
638 638
 
639 639
 
640
-/*
640
+/*! \brief
641 641
  * Duplicate linked list of parameters
642 642
  */
643 643
 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 679
 }
680 680
 
681 681
 
682
-/*
682
+/*! \brief
683 683
  * Duplicate linked list of parameters
684 684
  */
685 685
 int duplicate_params(param_t** _n, param_t* _p)
... ...
@@ -688,7 +690,7 @@ int duplicate_params(param_t** _n, param_t* _p)
688 688
 }
689 689
 
690 690
 
691
-/*
691
+/*! \brief
692 692
  * Duplicate linked list of parameters
693 693
  */
694 694
 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 123
 	struct param* sla;
124 124
 };
125 125
 
126
-/*
126
+/*! \brief
127 127
  * Union of hooks structures for all classes
128 128
  */
129 129
 typedef union param_hooks {
130
-	struct contact_hooks contact; /* Contact hooks */
131
-	struct uri_hooks uri;         /* URI hooks */
130
+	struct contact_hooks contact; /*!< Contact hooks */
131
+	struct uri_hooks uri;         /*!< URI hooks */
132 132
 	struct event_dialog_hooks event_dialog;
133 133
 } param_hooks_t;
134 134
 
135
-/**
135
+/*! \brief
136 136
  * Only parse one parameter
137 137
  * @Return:
138 138
  * 	t: out parameter
... ...
@@ -143,44 +150,44 @@ typedef union param_hooks {
143 143
 inline int parse_param(str *_s, pclass_t _c, param_hooks_t *_h, param_t *t);
144 144
 
145 145
 
146
-/*
146
+/*! \brief
147 147
  * 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
148
+ *  \param _s is string containing parameters
149
+ *  \param _c is class of parameters
150
+ *  \param _h is pointer to structure that will be filled with pointer to well known parameters
151 151
  * linked list of parsed parameters will be stored in
152 152
  * the variable _p is pointing to
153
- * The function returns 0 on success and negative number
153
+ * \return The function returns 0 on success and negative number
154 154
  * on an error
155 155
  */
156 156
 int parse_params(str* _s, pclass_t _c, param_hooks_t* _h, param_t** _p);
157 157
 
158 158
 
159
-/*
159
+/*! \brief
160 160
  * Free linked list of parameters
161 161
  */
162 162
 void free_params(param_t* _p);
163 163
 
164 164
 
165
-/*
165
+/*! \brief
166 166
  * Free linked list of parameters from shared memory
167 167
  */
168 168
 void shm_free_params(param_t* _p);
169 169
 
170 170
 
171
-/*
171
+/*! \brief
172 172
  * Print linked list of parameters, just for debugging
173 173
  */
174 174
 void print_params(FILE* _o, param_t* _p);
175 175
 
176 176
 
177
-/*
177
+/*! \brief
178 178
  * Duplicate linked list of parameters
179 179
  */
180 180
 int duplicate_params(param_t** _n, param_t* _p);
181 181
 
182 182
 
183
-/*
183
+/*! \brief
184 184
  * Duplicate linked list of parameters
185 185
  */
186 186
 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 22
  * along with this program; if not, write to the Free Software 
23 23
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 24
  */
25
+
26
+/*! \file
27
+ * \brief Parser :: Refert-To: header parser
28
+ *
29
+ * \ingroup parser
30
+ */
25 31
  
26 32
 #include "parse_from.h"
27 33
 #include "parse_to.h"
... ...
@@ -33,7 +34,7 @@
33 33
 #include "../mem/mem.h"
34 34
 
35 35
  
36
-/*
36
+/*! \brief
37 37
  * This method is used to parse Refer-To header.
38 38
  *
39 39
  * 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 22
  * along with this program; if not, write to the Free Software 
23 23
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 24
  */
25
- 
25
+
26
+/*! \file
27
+ * \brief Parser :: Refert-To: header parser
28
+ *
29
+ * \ingroup parser
30
+ */
26 31
  
27 32
 #ifndef PARSE_REFER_TO_H
28 33
 #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 29
  *  2007-07-27  created by andrei
30 30
  */
31 31
 
32
+/*! \file
33
+ * \brief Parser :: Retry-After: header parser
34
+ *
35
+ * \ingroup parser
36
+ */
37
+ 
32 38
 
33 39
 #include "../comp_defs.h"
34 40
 #include "parse_retry_after.h"
... ...
@@ -37,7 +38,7 @@
37 37
 #include "../dprint.h"
38 38
 #include "../mem/mem.h"
39 39
 
40
-/* Parse the Retry-after header field */
40
+/*! \brief Parse the Retry-after header field */
41 41
 char* parse_retry_after(char *buf, char* end, unsigned* after, int* err)
42 42
 {
43 43
 	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 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Retry-After: header parser
30
+ *
31
+ * \ingroup parser
32
+ */
28 33
 
29 34
 #ifndef _parse_retry_after_h
30 35
 #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 22
  * along with this program; if not, write to the Free Software 
23 23
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 24
  */
25
+
26
+/*! \file
27
+ * \brief Parser :: Remote-party-id: header parser
28
+ *
29
+ * \ingroup parser
30
+ */
25 31
  
26 32
 #include "parse_from.h"
27 33
 #include "parse_to.h"
... ...
@@ -33,7 +34,7 @@
33 33
 #include "../mem/mem.h"
34 34
 
35 35
  
36
-/*
36
+/*! \brief
37 37
  * This method is used to parse RPID header.
38 38
  *
39 39
  * 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 30
 #include "msg_parser.h"
31 31
  
32 32
  
33
-/* casting macro for accessing RPID body */
33
+/*! \brief casting macro for accessing RPID body */
34 34
 #define get_rpid(p_msg)  ((struct to_body*)(p_msg)->rpid->parsed)
35 35
 
36 36
 
... ...
@@ -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 41
 #include "../trim.h"
42 42
 #include "../ut.h"
43 43
 
44
-/*
44
+/*! \brief
45 45
  * Parse Route or Record-Route body
46 46
  */
47 47
 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 144
 	return 0;
145 145
 }
146 146
 
147
-/*
147
+/*! \brief
148 148
  * Wrapper to do_parse_rr_body() for external calls
149 149
  */
150 150
 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 152
 	return do_parse_rr_body(buf, len, head);
153 153
 }
154 154
 
155
-/*
155
+/*! \brief
156 156
  * Parse Route and Record-Route header fields
157 157
  */
158 158
 int parse_rr(struct hdr_field* _h)
... ...
@@ -175,7 +181,7 @@ int parse_rr(struct hdr_field* _h)
175 175
 	return 0;
176 176
 }
177 177
 
178
-/*
178
+/*! \brief
179 179
  * Free list of rrs
180 180
  * _r is head of the list
181 181
  */
... ...
@@ -196,7 +202,7 @@ static inline void do_free_rr(rr_t** _r, int _shm)
196 196
 }
197 197
 
198 198
 
199
-/*
199
+/*! \brief
200 200
  * Free list of rrs
201 201
  * _r is head of the list
202 202
  */
... ...
@@ -207,7 +213,7 @@ void free_rr(rr_t** _r)
207 207
 }
208 208
 
209 209
 
210
-/*
210
+/*! \brief
211 211
  * Free list of rrs
212 212
  * _r is head of the list
213 213
  */
... ...
@@ -218,7 +224,7 @@ void shm_free_rr(rr_t** _r)
218 218
 }
219 219
 
220 220
 
221
-/*
221
+/*! \brief
222 222
  * Print list of RRs, just for debugging
223 223
  */
224 224
 void print_rr(FILE* _o, rr_t* _r)
... ...
@@ -241,7 +247,7 @@ void print_rr(FILE* _o, rr_t* _r)
241 241
 }
242 242
 
243 243
 
244
-/*
244
+/*! \brief
245 245
  * Translate all pointers in the structure and also
246 246
  * in all parameters in the list
247 247
  */
... ...
@@ -260,7 +266,7 @@ static inline void xlate_pointers(rr_t* _orig, rr_t* _r)
260 260
 }
261 261
 
262 262
 
263
-/*
263
+/*! \brief
264 264
  * Duplicate a single rr_t structure using pkg_malloc or shm_malloc
265 265
  */
266 266
 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 321
 }
322 322
 
323 323
 
324
-/*
324
+/*! \brief
325 325
  * Duplicate a single rr_t structure using pkg_malloc
326 326
  */
327 327
 int duplicate_rr(rr_t** _new, rr_t* _r)
... ...
@@ -330,7 +336,7 @@ int duplicate_rr(rr_t** _new, rr_t* _r)
330 330
 }
331 331
 
332 332
 
333
-/*
333
+/*! \brief
334 334
  * Duplicate a single rr_t structure using pkg_malloc
335 335
  */
336 336
 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 38
 #include "hf.h"
39 39
 
40 40
 
41
-/*
41
+/*! \brief
42 42
  * Structure representing a Route & Record-Route HF body
43 43
  */
44 44
 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 */
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 50
 } rr_t;
51 51
 
52 52
 
... ...
@@ -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 25
 }
26 26
 
27 27
 
28
-int
29
-etag_parser(char *_s, int _l, str *_e)
28
+int etag_parser(char *_s, int _l, str *_e)
30 29
 {
31 30
         char* end;
32 31
 
... ...
@@ -47,8 +52,7 @@ etag_parser(char *_s, int _l, str *_e)
47 47
 }
48 48
 
49 49
 
50
-int
51
-parse_sipifmatch(struct hdr_field* _h)
50
+int parse_sipifmatch(struct hdr_field* _h)
52 51
 {
53 52
 	str *e;
54 53
 
... ...
@@ -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 9
 } etag_t;
10 10
 
11 11
 
12
-/*
12
+/*! \brief
13 13
  * Parse Sipifmatch HF body
14 14
  */
15 15
 int parse_sipifmatch(struct hdr_field* _h);
16 16
 
17 17
 
18
-/*
18
+/*! \brief
19 19
  * Release memory
20 20
  */
21 21
 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 29
  * 2003-04-26 ZSW (jiri)
30 30
  */
31 31
 
32
+/*! \file
33
+ * \brief Parser :: Parse To: header
34
+ *
35
+ * \ingroup parser
36
+ */
32 37
 
33 38
 #include "parse_to.h"
34 39
 #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 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/*! \file
29
+ * \brief Parser :: Parse To: header
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
34
+#include "parse_to.h"
35
+
28 36
 
29 37
 #ifndef PARSE_TO
30 38
 #define PARSE_TO
... ...
@@ -37,22 +40,22 @@ enum {
37 37
 };
38 38
 
39 39
 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 */
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 */
44 44
 };
45 45
 
46 46
 
47 47
 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 */
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 */
53 53
 	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 */
54
+	struct to_param *param_lst;   /*!< Linked list of parameters */
55
+	struct to_param *last_param;  /*!< Last parameter in the list */
56 56
 };
57 57
 
58 58
 
... ...
@@ -60,7 +63,7 @@ struct to_body{
60 60
 #define get_to( p_msg)      ((struct to_body*)(p_msg)->to->parsed)
61 61
 
62 62
 
63
-/*
63
+/*! \brief
64 64
  * To header field parser
65 65
  */
66 66
 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 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 26
  */
27 27
 
28
+/** @file
29
+ * @brief Parser :: Parse URI's
30
+ *
31
+ * @ingroup parser
32
+ */
28 33
 
29 34
 #ifndef PARSE_URI_H
30 35
 #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 67
 
68 68
 
69 69
 
70
-/* main via states (uri:port ...) */
70
+/** \brief main via states (uri:port ...) */
71 71
 enum {	         
72 72
 	F_HOST, P_HOST,
73 73
 	L_PORT, F_PORT, P_PORT,
... ...
@@ -82,7 +86,7 @@ enum {
82 82
 };
83 83
 
84 84
 
85
-/* first via part state */
85
+/** \brief first via part state */
86 86
 enum {
87 87
 	F_SIP = 100,
88 88
 	SIP1, SIP2, FIN_SIP,
... ...
@@ -96,7 +100,7 @@ enum {
96 96
 };
97 97
 
98 98
 
99
-/* param related states
99
+/** \brief param related states
100 100
  * WARNING: keep in sync with parse_via.h, PARAM_HIDDEN, ...
101 101
  */
102 102
 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 33
  */