Browse code

Doxygen for the parser directory

There's still a lot of files untouched. Feel free to jump in and help!

oej authored on 25/10/2009 15:58:41
Showing 42 changed files
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (C) 2001-2003 FhG Fokus
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -27,6 +22,12 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file 
26
+ * \brief Parser :: Accept, Accept-Language, Accept-Contact, Accept-Disposition Header Field Name Parsing Macros
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
30 31
 #ifndef CASE_ACCE_H
31 32
 #define CASE_ACCE_H
32 33
 
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (C) 2001-2003 FhG Fokus
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -27,6 +22,12 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file 
26
+ * \brief Parser :: Allow, Allow-Events Header Field Name Parsing Macros
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
30 31
 #ifndef CASE_ALLO_H
31 32
 #define CASE_ALLO_H
32 33
 
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (C) 2001-2003 FhG Fokus
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -26,6 +21,11 @@
26 21
  * along with this program; if not, write to the Free Software 
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
24
+/*! \file 
25
+ * \brief Parser :: Authorization Header Field Name Parsing Macros
26
+ *
27
+ * \ingroup parser
28
+ */
29 29
 
30 30
 #ifndef CASE_AUTH_H
31 31
 #define CASE_AUTH_H
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (C) 2001-2003 FhG Fokus
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -32,6 +27,12 @@
32 27
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 28
  */
34 29
 
30
+/*! \file 
31
+ * \brief Parser :: Call-ID Header Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ *
35
+ */
35 36
 
36 37
 #ifndef CASE_CALL_H
37 38
 #define CASE_CALL_H
... ...
@@ -6,19 +6,14 @@
6 6
  *
7 7
  * Copyright (C) 2001-2003 FhG Fokus
8 8
  *
9
- * This file is part of ser, a free SIP server.
9
+ * This file is part of SIP-router, a free SIP server.
10 10
  *
11
- * ser is free software; you can redistribute it and/or modify
11
+ * SIP-router is free software; you can redistribute it and/or modify
12 12
  * it under the terms of the GNU General Public License as published by
13 13
  * the Free Software Foundation; either version 2 of the License, or
14 14
  * (at your option) any later version
15 15
  *
16
- * For a license to use the ser software under conditions
17
- * other than those described here, or to purchase support for this
18
- * software, please contact iptel.org by e-mail at the following addresses:
19
- *    info@iptel.org
20
- *
21
- * ser is distributed in the hope that it will be useful,
16
+ * SIP-router is distributed in the hope that it will be useful,
22 17
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 18
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 19
  * GNU General Public License for more details.
... ...
@@ -33,6 +28,14 @@
33 28
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
34 29
  */
35 30
 
31
+/*! \file 
32
+ * \brief Parser :: Contact, Content-Type, Content-Length, Content-Disposition, Content-Encoding
33
+ * Header Field Name Parsing Macros
34
+ *
35
+ * \ingroup parser
36
+ */
37
+
38
+
36 39
 
37 40
 #ifndef CASE_CONT_H
38 41
 #define CASE_CONT_H
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (C) 2001-2003 FhG Fokus
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -27,6 +22,14 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file 
26
+ * \brief Parser :: CSeq Header Field Name Parsing Macros
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
31
+
32
+
30 33
 
31 34
 #ifndef CASE_CSEQ_H
32 35
 #define CASE_CSEQ_H
... ...
@@ -5,19 +5,14 @@
5 5
  *
6 6
  * Copyright (c) 2007 iptelorg GmbH
7 7
  *
8
- * This file is part of ser, a free SIP server.
8
+ * This file is part of SIP-router, a free SIP server.
9 9
  *
10
- * ser is free software; you can redistribute it and/or modify
10
+ * SIP-router is free software; you can redistribute it and/or modify
11 11
  * it under the terms of the GNU General Public License as published by
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
- * ser is distributed in the hope that it will be useful,
15
+ * SIP-router 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
23 18
  * GNU General Public License for more details.
... ...
@@ -27,6 +22,13 @@
27 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 23
  */
29 24
 
25
+/*! \file 
26
+ * \brief Parser :: Date Header Field Name Parsing Macros
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
31
+
30 32
 
31 33
 #ifndef CASE_DATE_H
32 34
 #define CASE_DATE_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Diversion Header Field Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_DIVE_H
32 39
 #define CASE_DIVE_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser ::  Event Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_EVEN_H
32 39
 #define CASE_EVEN_H
... ...
@@ -32,6 +32,13 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 33
  */
34 34
 
35
+/*! \file 
36
+ * \brief Parser ::  Expires Header Field Name Parsing Macros 
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
41
+
35 42
 
36 43
 #ifndef CASE_EXPI_H
37 44
 #define CASE_EXPI_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: From Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_FROM_H
32 39
 #define CASE_FROM_H
... ...
@@ -30,6 +30,12 @@
30 30
  * --------
31 31
  */
32 32
 
33
+/*! \file 
34
+ * \brief Parser :: Identity, Identity-info Header Field Name Parsing Macros
35
+ *
36
+ * \ingroup parser
37
+ */
38
+
33 39
 
34 40
 #ifndef CASE_IDEN_H
35 41
 #define CASE_IDEN_H
... ...
@@ -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 :: Max-Forwards Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_MAX_H
32 38
 #define CASE_MAX_H
... ...
@@ -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 :: Min-SE Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_MIN_H
32 38
 #define CASE_MIN_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Organization Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_ORGA_H
32 39
 #define CASE_ORGA_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Path Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_PATH_H
32 39
 #define CASE_PATH_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Priority Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_PRIO_H
32 39
 #define CASE_PRIO_H
... ...
@@ -22,6 +22,13 @@
22 22
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23 23
  */
24 24
 
25
+/*! \file 
26
+ * \brief Parser :: Call-ID Header Name Parsing Macros
27
+ *
28
+ * \ingroup parser
29
+ */
30
+
31
+
25 32
 #ifndef _CASE_PRIV_H
26 33
 #define _CASE_PRIV_H
27 34
 
... ...
@@ -32,6 +32,12 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 33
  */
34 34
 
35
+/*! \file 
36
+ * \brief Parser :: Proxy-Require, Proxy-Authorization Header Field Name Parsing Macros
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
35 41
 
36 42
 #ifndef CASE_PROX_H
37 43
 #define CASE_PROX_H
... ...
@@ -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 :: Record-Route Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_RECO_H
32 38
 #define CASE_RECO_H
... ...
@@ -1,6 +1,4 @@
1 1
 /*
2
- * Refer-To Header Field Name Parsing Macros
3
- *
4 2
  * Refer-To, Referred-By Header Field Name Parsing Macros
5 3
  *
6 4
  * Copyright (C) 2005 Juha Heinanen
... ...
@@ -27,6 +25,13 @@
27 25
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 26
  */
29 27
 
28
+/*! \file 
29
+ * \brief Parser :: Refer-To, Referred-By Header Field Name Parsing Macros
30
+ *
31
+ * \ingroup parser
32
+ */
33
+
34
+
30 35
 #ifndef CASE_REFE_H
31 36
 #define CASE_REFE_H
32 37
 
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Reject-Contact Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 #ifndef CASE_REJE_H
31 38
 #define CASE_REJE_H
32 39
 
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Remote-Party-ID Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 #ifndef CASE_REMO_H
31 38
 #define CASE_REMO_H
32 39
 
... ...
@@ -32,6 +32,13 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 33
  */
34 34
 
35
+/*! \file 
36
+ * \brief Parser ::  Require, Request-Disposition Header Field Name Parsing Macros
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
41
+
35 42
 
36 43
 #ifndef CASE_REQU_H
37 44
 #define CASE_REQU_H
... ...
@@ -31,6 +31,12 @@
31 31
  *  2007-07-27  created by andrei
32 32
  */
33 33
 
34
+/*! \file 
35
+ * \brief Parser ::  Expires Header Field Name Parsing Macros
36
+ *
37
+ * \ingroup parser
38
+ */
39
+
34 40
 
35 41
 #ifndef CASE_RETR_H
36 42
 #define CASE_RETR_H
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser ::  Route Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_ROUT_H
32 39
 #define CASE_ROUT_H
... ...
@@ -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 ::  Subject Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_SERV_H
32 38
 #define CASE_SERV_H
... ...
@@ -27,6 +27,14 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Session-Expires Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
37
+
30 38
 #ifndef CASE_SESS_H
31 39
 #define CASE_SESS_H
32 40
 
... ...
@@ -1,3 +1,10 @@
1
+/*! \file 
2
+ * \brief Parser :: Handle case for headers
3
+ *
4
+ * \ingroup parser
5
+ */
6
+
7
+
1 8
 #ifndef CASE_SIP_H
2 9
 #define CASE_SIP_H
3 10
 
... ...
@@ -27,6 +27,13 @@
27 27
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28 28
  */
29 29
 
30
+/*! \file 
31
+ * \brief Parser :: Subject Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
36
+
30 37
 
31 38
 #ifndef CASE_SUBJ_H
32 39
 #define CASE_SUBJ_H
... ...
@@ -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 :: Subject Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_SUBS_H
32 38
 #define CASE_SUBS_H
... ...
@@ -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 :: Supported Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
30 35
 
31 36
 #ifndef CASE_SUPP_H
32 37
 #define CASE_SUPP_H
... ...
@@ -32,6 +32,12 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 33
  */
34 34
 
35
+/*! \file 
36
+ * \brief Parser :: To Header Field Name Parsing Macros
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
35 41
 
36 42
 #ifndef CASE_TO_H
37 43
 #define CASE_TO_H
... ...
@@ -32,6 +32,12 @@
32 32
  * 2003-01-27 next baby-step to removing ZT - PRESERVE_ZT (jiri)
33 33
  */
34 34
 
35
+/*! \file 
36
+ * \brief Parser :: Unspoorted Header Field Name Parsing Macros
37
+ *
38
+ * \ingroup parser
39
+ */
40
+
35 41
 
36 42
 #ifndef CASE_UNSU_H
37 43
 #define CASE_UNSU_H
... ...
@@ -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 :: User-Agent Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 #ifndef CASE_USER_H
31 37
 #define CASE_USER_H
32 38
 
... ...
@@ -31,6 +31,13 @@
31 31
  * 2003-02-28 scratchpad compatibility abandoned (jiri)
32 32
  */
33 33
 
34
+/*! \file 
35
+ * \brief Parser :: Via Header Field Name Parsing Macros
36
+ *
37
+ * \ingroup parser
38
+ */
39
+
40
+
34 41
 
35 42
 #ifndef CASE_VIA_H
36 43
 #define CASE_VIA_H
... ...
@@ -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 :: WWW-Authenticate Header Field Name Parsing Macros
32
+ *
33
+ * \ingroup parser
34
+ */
35
+
30 36
 
31 37
 #ifndef CASE_WWW_H
32 38
 #define CASE_WWW_H
... ...
@@ -33,6 +33,12 @@
33 33
  * 2007-07-27 added HDR_RETRY_AFTER_T (andrei)
34 34
  */
35 35
 
36
+/*! \file 
37
+ * \brief Parser :: 
38
+ *
39
+ * \ingroup parser
40
+ */
41
+
36 42
 
37 43
 #include "hf.h"
38 44
 #include "parse_via.h"
... ...
@@ -55,8 +61,7 @@
55 61
 #include "parse_allow.h"
56 62
 #include "../ut.h"
57 63
 
58
-
59
-/*
64
+/*! \brief
60 65
  * Frees a hdr_field structure,
61 66
  * WARNING: it frees only parsed (and not name.s, body.s)
62 67
  */
... ...
@@ -225,7 +230,7 @@ void clean_hdr_field(struct hdr_field* hf)
225 230
 }
226 231
 
227 232
 
228
-/*
233
+/*! \brief
229 234
  * Frees a hdr_field list,
230 235
  * WARNING: frees only ->parsed and ->next*/
231 236
 void free_hdr_field_lst(struct hdr_field* hf)
... ...
@@ -35,6 +35,13 @@
35 35
  * 2007-07-27 HDR_RETRY_AFTER_[TF] added (andrei)
36 36
  */
37 37
 
38
+/*! \file 
39
+ * \brief Parser :: ???
40
+ *
41
+ * \ingroup parser
42
+ */
43
+
44
+
38 45
 
39 46
 #ifndef HF_H
40 47
 #define HF_H
... ...
@@ -44,7 +51,9 @@
44 51
 
45 52
 
46 53
 
47
-/* header type enum
54
+/*! \brief header type enum
55
+ * 
56
+ * \note
48 57
  * if you add a new type:
49 58
  *  - make sure it's not greater than 63
50 59
  *  - make sure you add the corresponding flag to the hdr_flags_t defs below
... ...
@@ -55,78 +64,79 @@
55 64
  */
56 65
 
57 66
 enum _hdr_types_t {
58
-	HDR_ERROR_T					= -1   /* Error while parsing */,
59
-	HDR_OTHER_T					=  0   /* Some other header field */,
60
-	HDR_VIA_T					=  1   /* Via header field */,
61
-	HDR_VIA1_T					=  1   /* First Via header field */,
62
-	HDR_VIA2_T					=  2   /* only used as flag */,
63
-	HDR_TO_T					       /* To header field */,
64
-	HDR_FROM_T					       /* From header field */,
65
-	HDR_CSEQ_T					       /* CSeq header field */,
66
-	HDR_CALLID_T				       /* Call-Id header field */,
67
-	HDR_CONTACT_T				       /* Contact header field */,
68
-	HDR_MAXFORWARDS_T			       /* MaxForwards header field */,
69
-	HDR_ROUTE_T					       /* Route header field */,
70
-	HDR_RECORDROUTE_T			       /* Record-Route header field */,
71
-	HDR_CONTENTTYPE_T			       /* Content-Type header field */,
72
-	HDR_CONTENTLENGTH_T			       /* Content-Length header field */,
73
-	HDR_AUTHORIZATION_T			       /* Authorization header field */,
74
-	HDR_EXPIRES_T				       /* Expires header field */,
75
-	HDR_PROXYAUTH_T				       /* Proxy-Authorization hdr field */,
76
-	HDR_SUPPORTED_T				       /* Supported  header field */,
77
-	HDR_REQUIRE_T				       /* Require header */,
78
-	HDR_PROXYREQUIRE_T			       /* Proxy-Require header field */,
79
-	HDR_UNSUPPORTED_T			       /* Unsupported header field */,
80
-	HDR_ALLOW_T					       /* Allow header field */,
81
-	HDR_EVENT_T					       /* Event header field */,
82
-	HDR_ACCEPT_T				       /* Accept header field */,
83
-	HDR_ACCEPTLANGUAGE_T		       /* Accept-Language header field */,
84
-	HDR_ORGANIZATION_T			       /* Organization header field */,
85
-	HDR_PRIORITY_T				       /* Priority header field */,
86
-	HDR_SUBJECT_T				       /* Subject header field */,
87
-	HDR_USERAGENT_T				       /* User-Agent header field */,
88
-	HDR_SERVER_T				       /* Server header field */,
89
-	HDR_ACCEPTDISPOSITION_T		       /* Accept-Disposition hdr field */,
90
-	HDR_CONTENTDISPOSITION_T	       /* Content-Disposition hdr field */,
91
-	HDR_DIVERSION_T				       /* Diversion header field */,
92
-	HDR_RPID_T					       /* Remote-Party-ID header field */,
93
-	HDR_REFER_TO_T				       /* Refer-To header fiels */,
94
-	HDR_SIPIFMATCH_T			       /* SIP-If-Match header field */,
95
-	HDR_SESSIONEXPIRES_T		       /* Session-Expires header */,
96
-	HDR_MIN_SE_T				       /* Min-SE */,
97
-	HDR_SUBSCRIPTION_STATE_T	       /* Subscription-State */,
98
-	HDR_ACCEPTCONTACT_T			       /* Accept-Contact header */,
99
-	HDR_ALLOWEVENTS_T			       /* Allow-Events header */,
100
-	HDR_CONTENTENCODING_T		       /* Content-Encoding header */,
101
-	HDR_REFERREDBY_T			       /* Referred-By header */,
102
-	HDR_REJECTCONTACT_T			       /* Reject-Contact header */,
103
-	HDR_REQUESTDISPOSITION_T	       /* Request-Disposition header */,
104
-	HDR_WWW_AUTHENTICATE_T		       /* WWW-Authenticate header field */,
105
-	HDR_PROXY_AUTHENTICATE_T	       /* Proxy-Authenticate header field */,
106
-	HDR_DATE_T			       /* Date header field */,
107
-	HDR_IDENTITY_T			       /* Identity header field */,
108
-	HDR_IDENTITY_INFO_T		       /* Identity-info header field */,
109
-	HDR_RETRY_AFTER_T		           /* Retry-After header field */,
110
-	HDR_PPI_T                          /**< P-Preferred-Identity header field */,
111
-	HDR_PAI_T                          /**< P-Asserted-Identity header field */,
112
-	HDR_PATH_T                         /**< Path header field */,
113
-	HDR_PRIVACY_T				       /**< Privacy header field */,
114
-	HDR_EOH_T					       /* End of message header */
67
+	HDR_ERROR_T					= -1   /*!< Error while parsing */,
68
+	HDR_OTHER_T					=  0   /*!< Some other header field */,
69
+	HDR_VIA_T					=  1   /*!< Via header field */,
70
+	HDR_VIA1_T					=  1   /*!< First Via header field */,
71
+	HDR_VIA2_T					=  2   /*!< only used as flag */,
72
+	HDR_TO_T					       /*!< To header field */,
73
+	HDR_FROM_T					       /*!< From header field */,
74
+	HDR_CSEQ_T					       /*!< CSeq header field */,
75
+	HDR_CALLID_T				       /*!< Call-Id header field */,
76
+	HDR_CONTACT_T				       /*!< Contact header field */,
77
+	HDR_MAXFORWARDS_T			       /*!< MaxForwards header field */,
78
+	HDR_ROUTE_T					       /*!< Route header field */,
79
+	HDR_RECORDROUTE_T			       /*!< Record-Route header field */,
80
+	HDR_CONTENTTYPE_T			       /*!< Content-Type header field */,
81
+	HDR_CONTENTLENGTH_T			       /*!< Content-Length header field */,
82
+	HDR_AUTHORIZATION_T			       /*!< Authorization header field */,
83
+	HDR_EXPIRES_T				       /*!< Expires header field */,
84
+	HDR_PROXYAUTH_T				       /*!< Proxy-Authorization hdr field */,
85
+	HDR_SUPPORTED_T				       /*!< Supported  header field */,
86
+	HDR_REQUIRE_T				       /*!< Require header */,
87
+	HDR_PROXYREQUIRE_T			       /*!< Proxy-Require header field */,
88
+	HDR_UNSUPPORTED_T			       /*!< Unsupported header field */,
89
+	HDR_ALLOW_T					       /*!< Allow header field */,
90
+	HDR_EVENT_T					       /*!< Event header field */,
91
+	HDR_ACCEPT_T				       /*!< Accept header field */,
92
+	HDR_ACCEPTLANGUAGE_T		       /*!< Accept-Language header field */,
93
+	HDR_ORGANIZATION_T			       /*!< Organization header field */,
94
+	HDR_PRIORITY_T				       /*!< Priority header field */,
95
+	HDR_SUBJECT_T				       /*!< Subject header field */,
96
+	HDR_USERAGENT_T				       /*!< User-Agent header field */,
97
+	HDR_SERVER_T				       /*!< Server header field */,
98
+	HDR_ACCEPTDISPOSITION_T		       /*!< Accept-Disposition hdr field */,
99
+	HDR_CONTENTDISPOSITION_T	       /*!< Content-Disposition hdr field */,
100
+	HDR_DIVERSION_T				       /*!< Diversion header field */,
101
+	HDR_RPID_T					       /*!< Remote-Party-ID header field */,
102
+	HDR_REFER_TO_T				       /*!< Refer-To header fiels */,
103
+	HDR_SIPIFMATCH_T			       /*!< SIP-If-Match header field */,
104
+	HDR_SESSIONEXPIRES_T		       /*!< Session-Expires header */,
105
+	HDR_MIN_SE_T				       /*!< Min-SE */,
106
+	HDR_SUBSCRIPTION_STATE_T	       /*!< Subscription-State */,
107
+	HDR_ACCEPTCONTACT_T			       /*!< Accept-Contact header */,
108
+	HDR_ALLOWEVENTS_T			       /*!< Allow-Events header */,
109
+	HDR_CONTENTENCODING_T		       /*!< Content-Encoding header */,
110
+	HDR_REFERREDBY_T			       /*!< Referred-By header */,
111
+	HDR_REJECTCONTACT_T			       /*!< Reject-Contact header */,
112
+	HDR_REQUESTDISPOSITION_T	       /*!< Request-Disposition header */,
113
+	HDR_WWW_AUTHENTICATE_T		       /*!< WWW-Authenticate header field */,
114
+	HDR_PROXY_AUTHENTICATE_T	       /*!< Proxy-Authenticate header field */,
115
+	HDR_DATE_T			       /*!< Date header field */,
116
+	HDR_IDENTITY_T			       /*!< Identity header field */,
117
+	HDR_IDENTITY_INFO_T		       /*!< Identity-info header field */,
118
+	HDR_RETRY_AFTER_T		           /*!< Retry-After header field */,
119
+	HDR_PPI_T                          /*!< P-Preferred-Identity header field */,
120
+	HDR_PAI_T                          /*!< P-Asserted-Identity header field */,
121
+	HDR_PATH_T                         /*!< Path header field */,
122
+	HDR_PRIVACY_T				       /*!< Privacy header field */,
123
+	HDR_EOH_T					       /*!< End of message header */
115 124
 };
116 125
 
117 126
 
118 127
 typedef unsigned long long hdr_flags_t;
119 128
 
120
-/* type to flag conversion
129
+/*! \brief type to flag conversion
121 130
  * WARNING: HDR_ERROR_T has no corresponding FLAG ! */
122 131
 #define HDR_T2F(type)	\
123 132
 		(((type)!=HDR_EOH_T)?((hdr_flags_t)1<<(type)):(~(hdr_flags_t)0))
124 133
 
125
-/* helper macro for easy defining and keeping in sync. the flags enum */
134
+/*! \brief helper macro for easy defining and keeping in sync. the flags enum */
126 135
 #define HDR_F_DEF(name)		HDR_T2F(HDR_##name##_T)
127 136
 
128
-/* flags definitions
137
+/*! \name flags definitions
129 138
  * (enum won't work with all the compiler (e.g. icc) due to the 64bit size) */
139
+/*!{ */
130 140
 #define HDR_EOH_F					HDR_F_DEF(EOH)
131 141
 #define HDR_VIA_F					HDR_F_DEF(VIA)
132 142
 #define HDR_VIA1_F					HDR_F_DEF(VIA1)
... ...
@@ -185,23 +195,25 @@ typedef unsigned long long hdr_flags_t;
185 195
 
186 196
 #define HDR_OTHER_F					HDR_F_DEF(OTHER)
187 197
 
198
+/*!} */ /* Doxygen end marker*/
199
+
188 200
 typedef enum _hdr_types_t hdr_types_t;
189 201
 
190
-/*
202
+/*! \brief
191 203
  * Format: name':' body
192 204
  */
193 205
 typedef struct hdr_field {
194
-	hdr_types_t type;       /* Header field type */
195
-	str name;               /* Header field name */
196
-	str body;               /* Header field body (may not include CRLF) */
197
-	int len;		/* length from hdr start until EoHF (incl.CRLF) */
198
-	void* parsed;           /* Parsed data structures */
199
-	struct hdr_field* next; /* Next header field in the list */
206
+	hdr_types_t type;       /*!< Header field type */
207
+	str name;               /*!< Header field name */
208
+	str body;               /*!< Header field body (may not include CRLF) */
209
+	int len;		/*!< length from hdr start until EoHF (incl.CRLF) */
210
+	void* parsed;           /*!< Parsed data structures */
211
+	struct hdr_field* next; /*!< Next header field in the list */
200 212
 } hdr_field_t;
201 213
 
202 214
 
203 215
 
204
-/* returns true if the header links allocated memory on parse field */
216
+/*! \brief returns true if the header links allocated memory on parse field */
205 217
 static inline int hdr_allocs_parse(struct hdr_field* hdr)
206 218
 {
207 219
 	switch(hdr->type){
... ...
@@ -227,13 +239,13 @@ static inline int hdr_allocs_parse(struct hdr_field* hdr)
227 239
 	}
228 240
 }
229 241
 
230
-/* frees a hdr_field structure,
242
+/*! \brief frees a hdr_field structure,
231 243
  * WARNING: it frees only parsed (and not name.s, body.s)
232 244
  */
233 245
 void clean_hdr_field(struct hdr_field* hf);
234 246
 
235 247
 
236
-/* frees a hdr_field list,
248
+/*! \brief frees a hdr_field list,
237 249
  * WARNING: frees only ->parsed and ->next
238 250
  */
239 251
 void free_hdr_field_lst(struct hdr_field* hf);
... ...
@@ -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
... ...
@@ -34,18 +29,28 @@
34 29
  * 2007-01-26 Macros for Identity, Identity-info, Date added (gergo)
35 30
  */
36 31
 
32
+/*! \file 
33
+ * \brief Parser :: Fast 32-bit Header Field Name Parser -- keys
34
+ *
35
+ * \ingroup parser
36
+ */
37
+
37 38
 #ifndef KEYS_H
38 39
 #define KEYS_H
39 40
 
40
-/*
41
+/*! \name Parser definitions
42
+\verbatim
41 43
  * a  b  c  d  e  f  g  h  i  j  k  l  m  n  o  p  q  r  s  t  u  v  w  x  y  z  :  ' ' -
42 44
  * 61 62 63 64 65 66 67 68 69 6a 6b 6c 6d 6e 6f 70 71 72 73 74 75 76 77 78 79 7a 3a 20  2d
45
+\endverbatim
43 46
  *
44 47
  * Test manually/visually if dword is intended string using:
45 48
  * awk '/^#define/ {printf("%s \"%c%c%c%c\" ... %s \n",  $3,strtonum("0x" substr($3,9,2)),strtonum("0x" substr($3,7,2)),strtonum("0x" substr($3,5,2)),strtonum("0x" substr($3,3,2)),$5)}' keys.h
46 49
  *
47 50
  */
48 51
 
52
+/*!{ */
53
+
49 54
 #define _acce_ 0x65636361   /* "acce" */
50 55
 #define _allo_ 0x6f6c6c61   /* "allo" */
51 56
 #define _auth_ 0x68747561   /* "auth" */
... ...
@@ -185,4 +190,6 @@
185 190
 #define _acy2_ 0x20796361   /* "acy " */
186 191
 #define _acy1_ 0x3a796361   /* "acy:" */
187 192
 
193
+/*!} */
194
+
188 195
 #endif /* KEYS_H */
... ...
@@ -41,6 +41,18 @@
41 41
  *		header fields (gergo)
42 42
  */
43 43
 
44
+/*! \file 
45
+ * \brief Parser :: SIP Message header proxy parser
46
+ *
47
+ * \ingroup parser
48
+ */
49
+
50
+/*! \defgroup parser
51
+ * 
52
+ * The SIP message parser
53
+ *
54
+ */
55
+
44 56
 
45 57
 #include <string.h>
46 58
 #include <stdlib.h>
... ...
@@ -45,6 +45,12 @@
45 45
  *  2007-03-14  added SIP_MSG_START(msg) macro
46 46
  */
47 47
 
48
+/*! \file 
49
+ * \brief Parser :: ???
50
+ *
51
+ * \ingroup parser
52
+ */
53
+
48 54
 
49 55
 #ifndef msg_parser_h
50 56
 #define msg_parser_h
... ...
@@ -66,50 +72,52 @@
66 72
 #include "../error.h"
67 73
 
68 74
 
69
-/* convenience short-cut macros */
75
+/*! \name convenience short-cut macros */
76
+/*! { */
70 77
 #define REQ_LINE(_msg) ((_msg)->first_line.u.request)
71 78
 #define REQ_METHOD first_line.u.request.method_value
72 79
 #define REPLY_STATUS first_line.u.reply.statuscode
73 80
 #define REPLY_CLASS(_reply) ((_reply)->REPLY_STATUS/100)
81
+/*! } */
74 82
 
75
-/* start of "actual" sip msg (start of first line) */
83
+/*! \brief start of "actual" sip msg (start of first line) */
76 84
 #define SIP_MSG_START(m)	((m)->first_line.u.request.method.s)
77 85
 
78
-/* number methods as power of two to allow bitmap matching */
86
+/*! \brief number methods as power of two to allow bitmap matching */
79 87
 enum request_method {
80
-	METHOD_UNDEF=0,           /* 0 - --- */
81
-	METHOD_INVITE=1,          /* 1 - 2^0 */
82
-	METHOD_CANCEL=2,          /* 2 - 2^1 */
83
-	METHOD_ACK=4,             /* 3 - 2^2 */
84
-	METHOD_BYE=8,             /* 4 - 2^3 */
85
-	METHOD_INFO=16,           /* 5 - 2^4 */
86
-	METHOD_REGISTER=32,       /* 6 - 2^5 */
87
-	METHOD_SUBSCRIBE=64,      /* 7 - 2^6 */
88
-	METHOD_NOTIFY=128,        /* 8 - 2^7 */
89
-	METHOD_MESSAGE=256,       /* 9 - 2^8 */
90
-	METHOD_OPTIONS=512,       /* 10 - 2^9 */
91
-	METHOD_PRACK=1024,        /* 11 - 2^10 */
92
-	METHOD_UPDATE=2048,       /* 12 - 2^11 */
93
-	METHOD_REFER=4096,        /* 13 - 2^12 */
94
-	METHOD_PUBLISH=8192,      /* 14 - 2^13 */
95
-	METHOD_OTHER=16384        /* 15 - 2^14 */
88
+	METHOD_UNDEF=0,           /*!< 0 - --- */
89
+	METHOD_INVITE=1,          /*!< 1 - 2^0 */
90
+	METHOD_CANCEL=2,          /*!< 2 - 2^1 */
91
+	METHOD_ACK=4,             /*!< 3 - 2^2 */
92
+	METHOD_BYE=8,             /*!< 4 - 2^3 */
93
+	METHOD_INFO=16,           /*!< 5 - 2^4 */
94
+	METHOD_REGISTER=32,       /*!< 6 - 2^5 */
95
+	METHOD_SUBSCRIBE=64,      /*!< 7 - 2^6 */
96
+	METHOD_NOTIFY=128,        /*!< 8 - 2^7 */
97
+	METHOD_MESSAGE=256,       /*!< 9 - 2^8 */
98
+	METHOD_OPTIONS=512,       /*!< 10 - 2^9 */
99
+	METHOD_PRACK=1024,        /*!< 11 - 2^10 */
100
+	METHOD_UPDATE=2048,       /*!< 12 - 2^11 */
101
+	METHOD_REFER=4096,        /*!< 13 - 2^12 */
102
+	METHOD_PUBLISH=8192,      /*!< 14 - 2^13 */
103
+	METHOD_OTHER=16384        /*!< 15 - 2^14 */
96 104
 };
97 105
 
98
-#define FL_FORCE_RPORT  (1 << 0)  /* force rport */
99
-#define FL_FORCE_ACTIVE (1 << 1)  /* force active SDP */
100
-#define FL_SDP_IP_AFS   (1 << 2)  /* SDP IP rewritten */
101
-#define FL_SDP_PORT_AFS (1 << 3)  /* SDP port rewritten */
102
-#define FL_SHM_CLONE    (1 << 4)  /* msg cloned in SHM as a single chunk */
103
-#define FL_TIMEOUT      (1 << 5)  /* message belongs to an "expired" branch
106
+#define FL_FORCE_RPORT  (1 << 0)  /*!< force rport */
107
+#define FL_FORCE_ACTIVE (1 << 1)  /*!< force active SDP */
108
+#define FL_SDP_IP_AFS   (1 << 2)  /*!< SDP IP rewritten */
109
+#define FL_SDP_PORT_AFS (1 << 3)  /*!< SDP port rewritten */
110
+#define FL_SHM_CLONE    (1 << 4)  /*!< msg cloned in SHM as a single chunk */
111
+#define FL_TIMEOUT      (1 << 5)  /*!< message belongs to an "expired" branch
104 112
 									 (for failure route use) */
105
-#define FL_REPLIED      (1 << 6)  /* message branch received at least one reply
113
+#define FL_REPLIED      (1 << 6)  /*!< message branch received at least one reply
106 114
 									 (for failure route use) */
107
-#define FL_HASH_INDEX   (1 << 7)  /* msg->hash_index contains a valid value (tm use)*/
115
+#define FL_HASH_INDEX   (1 << 7)  /*!< msg->hash_index contains a valid value (tm use)*/
108 116
 
109 117
 #define FL_MTU_TCP_FB   (1 << 8)
110 118
 #define FL_MTU_TLS_FB   (1 << 9)
111 119
 #define FL_MTU_SCTP_FB  (1 << 10)
112
-#define FL_ADD_LOCAL_RPORT  (1 << 11) /* add 'rport' to local via hdr */
120
+#define FL_ADD_LOCAL_RPORT  (1 << 11) /*!< add 'rport' to local via hdr */
113 121
 
114 122
 /* WARNING: Value (1 << 29) is temporarily reserved for use in kamailio acc
115 123
  * module (flag FL_REQ_UPSTREAM)! */
... ...
@@ -143,7 +151,7 @@ if (  (*tmp==(firstchar) || *tmp==((firstchar) | 32)) &&                  \
143 151
     !strncasecmp((req)->first_line.u.request.version.s,             \
144 152
 		SIP_VERSION, SIP_VERSION_LEN))
145 153
 
146
-/*
154
+/*! \brief
147 155
  * Return a URI to which the message should be really sent (not what should
148 156
  * be in the Request URI. The following fields are tried in this order:
149 157
  * 1) dst_uri
... ...
@@ -155,7 +163,7 @@ if (  (*tmp==(firstchar) || *tmp==((firstchar) | 32)) &&                  \
155 163
 (((m)->new_uri.s && (m)->new_uri.len) ? (&(m)->new_uri) : (&(m)->first_line.u.request.uri)))
156 164
 
157 165
 
158
-/*
166
+/*! \brief
159 167
  * Return the Reqeust URI of a message.
160 168
  * The following fields are tried in this order:
161 169
  * 1) new_uri
... ...
@@ -186,37 +194,37 @@ enum _uri_flags{
186 194
 }; /* bit fields */
187 195
 typedef enum _uri_flags uri_flags;
188 196
 
197
+/*! \brief The SIP uri object */
189 198
 struct sip_uri {
190
-	str user;     /* Username */
191
-	str passwd;   /* Password */
192
-	str host;     /* Host name */
193
-	str port;     /* Port number */
194
-	str params;   /* Parameters */
195
-	str sip_params; /* Parameters of the sip: URI.
199
+	str user;     /*!< Username */
200
+	str passwd;   /*!< Password */
201
+	str host;     /*!< Host name */
202
+	str port;     /*!< Port number */
203
+	str params;   /*!< Parameters */
204
+	str sip_params; /*!< Parameters of the sip: URI.
196 205
 			  * (If a tel: URI is embedded in a sip: URI, then
197 206
 			  * params points to the parameters of the tel: URI,
198 207
 			  * and sip_params to the parameters of the sip: URI. 
199 208
 			  */
200 209
 	str headers;
201 210
 	unsigned short port_no;
202
-	unsigned short proto; /* from transport */
203
-	uri_type type; /* uri scheme */
211
+	unsigned short proto; /*!< from transport */
212
+	uri_type type; /*!< uri scheme */
204 213
 	uri_flags flags;
205
-	/* parameters */
214
+	/*!< parameters */
206 215
 	str transport;
207 216
 	str ttl;
208 217
 	str user_param;
209 218
 	str maddr;
210 219
 	str method;
211 220
 	str lr;
212
-	str r2; /* ser specific rr parameter */
213
-	/* values */
214
-	str transport_val;
215
-	str ttl_val;
216
-	str user_param_val;
217
-	str maddr_val;
218
-	str method_val;
219
-	str lr_val; /* lr value placeholder for lr=on a.s.o*/
221
+	str r2; /*!< ser specific rr parameter */
222
+	str transport_val; /*!< transport value */
223
+	str ttl_val;	 /*!< TTL value */
224
+	str user_param_val; /*!< User= param value */
225
+	str maddr_val; /*!< Maddr= param value */
226
+	str method_val; /*!< Method value */
227
+	str lr_val; /*!< lr value placeholder for lr=on a.s.o*/
220 228
 	str r2_val;
221 229
 #ifdef USE_COMP
222 230
 	unsigned short comp;
... ...
@@ -232,8 +240,10 @@ typedef enum msg_body_type {
232 240
 	MSG_BODY_SDP
233 241
 } msg_body_type_t;
234 242
 
235
-/* This structure represents a generic SIP message body, regardless of the
236
- * body type. Body parsers are supposed to cast this structure to some other
243
+/*! \brief This structure represents a generic SIP message body, regardless of the
244
+ * body type.
245
+ * 
246
+ * Body parsers are supposed to cast this structure to some other
237 247
  * body-type specific structure, but the body type specific structure must
238 248
  * retain msg_body_type variable and a pointer to the free function as the 
239 249
  * first two variables within the structure.
... ...
@@ -244,16 +254,17 @@ typedef struct msg_body {
244 254
 } msg_body_t;
245 255
 
246 256
 
257
+/*! \brief The SIP message */
247 258
 typedef struct sip_msg {
248
-	unsigned int id;               /* message id, unique/process*/
249
-	snd_flags_t fwd_send_flags;    /* send flags for forwarding */
250
-	snd_flags_t rpl_send_flags;    /* send flags for replies */
251
-	struct msg_start first_line;   /* Message first line */
252
-	struct via_body* via1;         /* The first via */
253
-	struct via_body* via2;         /* The second via */
254
-	struct hdr_field* headers;     /* All the parsed headers*/
255
-	struct hdr_field* last_header; /* Pointer to the last parsed header*/
256
-	hdr_flags_t parsed_flag;    /* Already parsed header field types */
259
+	unsigned int id;               /*!< message id, unique/process*/
260
+	snd_flags_t fwd_send_flags;    /*!< send flags for forwarding */
261
+	snd_flags_t rpl_send_flags;    /*!< send flags for replies */
262
+	struct msg_start first_line;   /*!< Message first line */
263
+	struct via_body* via1;         /*!< The first via */
264
+	struct via_body* via2;         /*!< The second via */
265
+	struct hdr_field* headers;     /*!< All the parsed headers*/
266
+	struct hdr_field* last_header; /*!< Pointer to the last parsed header*/
267
+	hdr_flags_t parsed_flag;    /*!< Already parsed header field types */
257 268
 
258 269
 	     /* Via, To, CSeq, Call-Id, From, end of header*/
259 270
 	     /* pointers to the first occurrences of these headers;
... ...
@@ -307,43 +318,42 @@ typedef struct sip_msg {
307 318
 
308 319
 	struct msg_body* body;
309 320
 
310
-	char* eoh;        /* pointer to the end of header (if found) or null */
311
-	char* unparsed;   /* here we stopped parsing*/
321
+	char* eoh;        /*!< pointer to the end of header (if found) or null */
322
+	char* unparsed;   /*!< here we stopped parsing*/
312 323
 
313
-	struct receive_info rcv; /* source & dest ip, ports, proto a.s.o*/
324
+	struct receive_info rcv; /*!< source & dest ip, ports, proto a.s.o*/
314 325
 
315
-	char* buf;        /* scratch pad, holds a modified message,
326
+	char* buf;        /*!< scratch pad, holds a modified message,
316 327
 					   *  via, etc. point into it */
317
-	unsigned int len; /* message len (orig) */
328
+	unsigned int len; /*!< message len (orig) */
318 329
 
319 330
 	     /* modifications */
320 331
 
321
-	str new_uri; /* changed first line uri, when you change this
332
+	str new_uri; /*!< changed first line uri, when you change this
322 333
 	                don't forget to set parsed_uri_ok to 0*/
323 334
 
324
-	str dst_uri; /* Destination URI, must be forwarded to this URI if len != 0 */
335
+	str dst_uri; /*!< Destination URI, must be forwarded to this URI if len != 0 */
325 336
 
326 337
 	/* current uri */
327
-	int parsed_uri_ok; /* 1 if parsed_uri is valid, 0 if not, set if to 0
338
+	int parsed_uri_ok; /*!< 1 if parsed_uri is valid, 0 if not, set if to 0
328 339
 	                      if you modify the uri (e.g change new_uri)*/
329
-	struct sip_uri parsed_uri; /* speed-up > keep here the parsed uri*/
330
-	/* the same for original uri */
331
-	int parsed_orig_ruri_ok;
332
-	struct sip_uri parsed_orig_ruri;
340
+	struct sip_uri parsed_uri; /*!< speed-up > keep here the parsed uri*/
341
+	int parsed_orig_ruri_ok; /*!< 1 if parsed_orig_uri is valid, 0 if not, set if to 0
342
+                              if you modify the uri (e.g change new_uri)*/
343
+	struct sip_uri parsed_orig_ruri; /*!< speed-up > keep here the parsed orig uri*/
333 344
 
334
-	struct lump* add_rm;       /* used for all the forwarded requests/replies */
335
-	struct lump* body_lumps;     /* Lumps that update Content-Length */
336
-	struct lump_rpl *reply_lump; /* only for localy generated replies !!!*/
345
+	struct lump* add_rm;       /*!< used for all the forwarded requests/replies */
346
+	struct lump* body_lumps;     /*!< Lumps that update Content-Length */
347
+	struct lump_rpl *reply_lump; /*!< only for localy generated replies !!!*/
337 348
 
338
-	/* str add_to_branch;
349
+	/*! \brief str add_to_branch;
339 350
 	   whatever whoever want to append to branch comes here
340 351
 	*/
341 352
 	char add_to_branch_s[MAX_BRANCH_PARAM_LEN];
342 353
 	int add_to_branch_len;
343 354
 
344
-	     /* index to TM hash table; stored in core to avoid unnecessary calculations */
345
-	unsigned int  hash_index;
346
-	unsigned int msg_flags; /* flags used by core */
355
+	unsigned int  hash_index; /*!< index to TM hash table; stored in core to avoid unnecessary calculations */
356
+	unsigned int msg_flags; /*!< flags used by core */
347 357
 	     /* allows to set various flags on the message; may be used for
348 358
 	      *	simple inter-module communication or remembering processing state
349 359
 	      * reached
... ...
@@ -356,7 +366,7 @@ typedef struct sip_msg {
356 366
 	str path_vec;
357 367
 } sip_msg_t;
358 368
 
359
-/* pointer to a fakes message which was never received ;
369
+/*! \brief pointer to a fakes message which was never received ;
360 370
    (when this message is "relayed", it is generated out
361 371
     of the original request)
362 372
 */
... ...
@@ -372,12 +382,7 @@ char* get_hdr_field(char* buf, char* end, struct hdr_field* hdr);
372 382
 
373 383
 void free_sip_msg(struct sip_msg* msg);
374 384
 
375
-/* make sure all HFs needed for transaction identification have been
376
-   parsed; return 0 if those HFs can't be found
377
- */
378
-
379
-
380
-/* make sure all HFs needed for transaction identification have been
385
+/*! \brief make sure all HFs needed for transaction identification have been
381 386
    parsed; return 0 if those HFs can't be found
382 387
 */
383 388
 inline static int check_transaction_quadruple( struct sip_msg* msg )
... ...
@@ -393,7 +398,7 @@ inline static int check_transaction_quadruple( struct sip_msg* msg )
393 398
 
394 399
 
395 400
 
396
-/* calculate characteristic value of a message -- this value
401
+/*! \brief calculate characteristic value of a message -- this value
397 402
    is used to identify a transaction during the process of
398 403
    reply matching
399 404
  */
... ...
@@ -427,7 +432,7 @@ inline static int char_msg_val( struct sip_msg *msg, char *cv )
427 432
 }
428 433
 
429 434
 
430
-/* returns a pointer to the begining of the msg's body
435
+/*! \brief returns a pointer to the begining of the msg's body
431 436
  */
432 437
 inline static char* get_body(struct sip_msg *msg)
433 438
 {
... ...
@@ -452,12 +457,12 @@ inline static char* get_body(struct sip_msg *msg)
452 457
 }
453 458
 
454 459
 
455
-/*
460
+/*! \brief
456 461
  * Make a private copy of the string and assign it to dst_uri
457 462
  */
458 463
 int set_dst_uri(struct sip_msg* msg, str* uri);
459 464
 
460
-/* If the dst_uri is set to an URI then reset it */
465
+/*! \brief If the dst_uri is set to an URI then reset it */
461 466
 void reset_dst_uri(struct sip_msg* msg);
462 467
 
463 468
 struct hdr_field* get_hdr(struct sip_msg *msg, enum _hdr_types_t ht);