Browse code

Including configuration documentation from doc/cfg.txt in doxygen.

Note: This implements a change in the doxygen configuration file that needs to be implementted
on the web server too.

oej authored on 21/10/2009 07:56:25
Showing 3 changed files
... ...
@@ -26,11 +26,24 @@
26 26
  */
27 27
 /*!
28 28
  * \file
29
- * \brief SIP-router core ::  Core configuration
29
+ * \brief SIP-router core ::  Core configuration parser
30 30
  * \ingroup core
31 31
  * Module: \ref core
32
+ *
33
+ * See 
34
+ * - \ref ConfigCoreDoc
35
+ * - \ref ConfigEngine
36
+ * - \ref cfg_core.h
37
+ */
38
+/*!
39
+ * \page ConfigCoreDoc Documentation of configuration parser
40
+ * \section ConfigParser Configuration parser
41
+ * Further information
42
+ * - \ref ConfigEngine
43
+ * - \ref cfg_core.h
44
+ * \verbinclude cfg.txt
45
+ *
32 46
  */
33
-
34 47
 
35 48
 #include "dprint.h"
36 49
 #ifdef USE_DST_BLACKLIST
... ...
@@ -4,13 +4,13 @@
4 4
 # --------
5 5
 # 2007-12-06:	Created by Miklos
6 6
 
7
-SER Configuration Framework
7
+SIP-router Configuration Framework
8 8
 
9 9
 1. Overview
10 10
 ===============================================================================
11 11
 
12
-The configuration framework can be used by SER core and by the modules,
13
-to get and set internal variables on-the-fly, and eliminate SER restarts
12
+The configuration framework can be used by SIP-router core and by modules,
13
+to get and set internal variables on-the-fly, and eliminate server restarts
14 14
 whenever it is possible.
15 15
 
16 16
 The core and the modules can declare configuration variables, and can
... ...
@@ -569,7 +569,8 @@ EXCLUDE_SYMBOLS        =
569 569
 # directories that contain example code fragments that are included (see 
570 570
 # the \include command).
571 571
 
572
-EXAMPLE_PATH           = doc/doxygen/examples
572
+EXAMPLE_PATH           = doc/doxygen/examples \
573
+			doc
573 574
 
574 575
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
575 576
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp