Pārlūkot izejas kodu

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 16 gadi atpakaļ
vecāks
revīzija
3c86cd2594
3 mainītis faili ar 20 papildinājumiem un 6 dzēšanām
  1. 15 2
      cfg_core.c
  2. 3 3
      doc/cfg.txt
  3. 2 1
      doc/doxygen/ser.doxygen

+ 15 - 2
cfg_core.c

@@ -26,11 +26,24 @@
  */
  */
 /*!
 /*!
  * \file
  * \file
- * \brief SIP-router core ::  Core configuration
+ * \brief SIP-router core ::  Core configuration parser
  * \ingroup core
  * \ingroup core
  * Module: \ref core
  * Module: \ref core
+ *
+ * See 
+ * - \ref ConfigCoreDoc
+ * - \ref ConfigEngine
+ * - \ref cfg_core.h
+ */
+/*!
+ * \page ConfigCoreDoc Documentation of configuration parser
+ * \section ConfigParser Configuration parser
+ * Further information
+ * - \ref ConfigEngine
+ * - \ref cfg_core.h
+ * \verbinclude cfg.txt
+ *
  */
  */
-
 
 
 #include "dprint.h"
 #include "dprint.h"
 #ifdef USE_DST_BLACKLIST
 #ifdef USE_DST_BLACKLIST

+ 3 - 3
doc/cfg.txt

@@ -4,13 +4,13 @@
 # --------
 # --------
 # 2007-12-06:	Created by Miklos
 # 2007-12-06:	Created by Miklos
 
 
-SER Configuration Framework
+SIP-router Configuration Framework
 
 
 1. Overview
 1. Overview
 ===============================================================================
 ===============================================================================
 
 
-The configuration framework can be used by SER core and by the modules,
-to get and set internal variables on-the-fly, and eliminate SER restarts
+The configuration framework can be used by SIP-router core and by modules,
+to get and set internal variables on-the-fly, and eliminate server restarts
 whenever it is possible.
 whenever it is possible.
 
 
 The core and the modules can declare configuration variables, and can
 The core and the modules can declare configuration variables, and can

+ 2 - 1
doc/doxygen/ser.doxygen

@@ -569,7 +569,8 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see 
 # directories that contain example code fragments that are included (see 
 # the \include command).
 # the \include command).
 
 
-EXAMPLE_PATH           = doc/doxygen/examples
+EXAMPLE_PATH           = doc/doxygen/examples \
+			doc
 
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp