From d8dfa4434d9f121ad5c42cf3b298ccfba00c26f7 Mon Sep 17 00:00:00 2001
From: Russell Bryant <russell@russellbryant.com>
Date: Mon, 14 Nov 2005 19:00:38 +0000
Subject: finish merging doxygen updates from issue #5605

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@7096 65c4cc65-6c06-0410-ace0-fbb531ad65f3
---
 asterisk.c | 58 ++++++++++++++++++++++++++++++++++++----------------------
 1 file changed, 36 insertions(+), 22 deletions(-)

(limited to 'asterisk.c')

diff --git a/asterisk.c b/asterisk.c
index f2f7ace53..93831ac0f 100755
--- a/asterisk.c
+++ b/asterisk.c
@@ -21,6 +21,10 @@
 /*!
  * \mainpage Asterisk -- An Open Source Telephony Toolkit
  *
+ * \par Developer Documentation for Asterisk
+ * This is the main developer documentation for Asterisk. It is 
+ * generated by running "make progdocs".
+ * \par Additional documentation
  * \arg \ref DevDoc 
  * \arg \ref ConfigFiles
  *
@@ -121,32 +125,42 @@ ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 #define AST_MAX_CONNECTS 128
 #define NUM_MSGS 64
 
+/*! \brief Welcome message when starting a CLI interface */
 #define WELCOME_MESSAGE ast_verbose( "Asterisk " ASTERISK_VERSION ", Copyright (C) 1999 - 2005 Digium.\n"); \
 		ast_verbose( "Written by Mark Spencer <markster@digium.com>\n"); \
 		ast_verbose( "=========================================================================\n")
 
-int option_verbose=0;
-int option_debug=0;
-int option_exec_includes=0;
-int option_nofork=0;
-int option_quiet=0;
-int option_console=0;
-int option_highpriority=0;
-int option_remote=0;
-int option_exec=0;
-int option_initcrypto=0;
-int option_nocolor;
-int option_dumpcore = 0;
-int option_cache_record_files = 0;
-int option_timestamp = 0;
-int option_overrideconfig = 0;
-int option_reconnect = 0;
-int option_transcode_slin = 1;
-int option_transmit_silence_during_record = 0;
-int option_maxcalls = 0;
-double option_maxload = 0.0;
-int option_dontwarn = 0;
-int option_priority_jumping = 1;
+/*! \defgroup main_options 
+ \brief Main configuration options from \ref Config_ast "asterisk.conf" or 
+  the operating system command line when starting Asterisk 
+  Some of them can be changed in the CLI 
+ */
+/*! @{ */
+int option_verbose=0;			/*!< Verbosity level */
+int option_debug=0;			/*!< Debug level */
+int option_exec_includes=0;		/*!< Allow \#exec in config files? */
+int option_nofork=0;			/*!< Do not fork */
+int option_quiet=0;			/*!< Keep quiet */
+int option_console=0;			/*!< Console mode, no background */
+int option_highpriority=0;		/*!< Run in realtime Linux priority */
+int option_remote=0;			/*!< Remote CLI */
+int option_exec=0;			/*!< */
+int option_initcrypto=0;		/*!< Initialize crypto keys for RSA auth */
+int option_nocolor;			/*!< Don't use termcap colors */
+int option_dumpcore = 0;			/*!< Dump core when failing */
+int option_cache_record_files = 0;		/*!< Cache sound files */
+int option_timestamp = 0;			/*!< Timestamp in logging */
+int option_overrideconfig = 0;			/*!< */
+int option_reconnect = 0;			/*!< */
+int option_transcode_slin = 1;			/*!< */
+int option_maxcalls = 0;			/*!< */
+double option_maxload = 0.0;			/*!< Max load avg on system */
+int option_dontwarn = 0;			/*!< */
+int option_priority_jumping = 1;		/*!< Enable priority jumping as result value for apps */
+int option_transmit_silence_during_record = 0;	/*!< Transmit silence during record() app */
+
+/*! @} */
+
 int fully_booted = 0;
 char record_cache_dir[AST_CACHE_DIR_LEN] = AST_TMP_DIR;
 char debug_filename[AST_FILENAME_MAX] = "";
-- 
cgit v1.2.3