[sr-dev] git:master: Including configuration documentation from doc/cfg. txt in doxygen.

[Olle E. Johansson]

Module: sip-router
Branch: master
Commit: 3c86cd2594331e7e25654eebf07a5e75b00ffe5c
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=3c86cd2594331e7e25654eebf07a5e75b00ffe5c

Author: oej <oej at edvina.net>
Committer: oej <oej at edvina.net>
Date:   Wed Oct 21 09:56:25 2009 +0200

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.

---

 cfg_core.c              |   17 +++++++++++++++--
 doc/cfg.txt             |    6 +++---
 doc/doxygen/ser.doxygen |    3 ++-
 3 files changed, 20 insertions(+), 6 deletions(-)

diff --git a/cfg_core.c b/cfg_core.c
index 574dcb2..75fa69c 100644
--- a/cfg_core.c
+++ b/cfg_core.c
@@ -26,11 +26,24 @@
  */
 /*!
  * \file
- * \brief SIP-router core ::  Core configuration
+ * \brief SIP-router core ::  Core configuration parser
  * \ingroup 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"
 #ifdef USE_DST_BLACKLIST
diff --git a/doc/cfg.txt b/doc/cfg.txt
index e7be888..df1209c 100644
--- a/doc/cfg.txt
+++ b/doc/cfg.txt
@@ -4,13 +4,13 @@
 # --------
 # 2007-12-06:	Created by Miklos
 
-SER Configuration Framework
+SIP-router Configuration Framework
 
 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.
 
 The core and the modules can declare configuration variables, and can
diff --git a/doc/doxygen/ser.doxygen b/doc/doxygen/ser.doxygen
index 1b91f40..9072e10 100644
--- a/doc/doxygen/ser.doxygen
+++ b/doc/doxygen/ser.doxygen
@@ -569,7 +569,8 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see 
 # 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 
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp