Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_config.h

Timestamp:

Jun 17, 2006 4:08:30 AM (18 years ago)

Author:

bennylp

Message:

Modifications all over the place, but mainly only to update Doxygen documentation

File:

• pjproject/trunk/pjsip/include/pjsip/sip_config.h (modified) (8 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_config.h

@@ -20 +20 @@
 #define __PJSIP_SIP_CONFIG_H__
 
+/**
+ * @file sip_config.h
+ * @brief Compile time configuration.
+ */
 #include <pj/config.h>
+
+/**
+ * @defgroup PJSIP PJSIP Library Collection
+ */
+
+/**
+ * @defgroup PJSIP_CORE Core SIP Library
+ * @ingroup PJSIP
+ * @brief The core framework from which all other SIP components depends on.
+ * 
+ * The PJSIP Core library only provides transport framework, event
+ * dispatching/module framework, and SIP message representation and
+ * parsing. It doesn't do anything usefull in itself!
+ *
+ * If application wants the stack to do anything usefull at all,
+ * it must registers @ref PJSIP_MOD to the core library. Examples
+ * of modules are @ref PJSIP_TRANSACT and @ref PJSUA_UA.
+ */
+
+/**
+ * @defgroup PJSIP_BASE Base Types
+ * @ingroup PJSIP_CORE
+ * @brief Basic PJSIP types and configurations.
+ */
+
+/**
+ * @defgroup PJSIP_CONFIG Compile Time Configuration
+ * @ingroup PJSIP_BASE
+ * @brief PJSIP compile time configurations.
+ * @{
+ */
 
 /**
@@ -74 +109 @@
 #ifndef PJSIP_MAX_MODULE
 #   define PJSIP_MAX_MODULE             16
+#endif
+
+
+/**
+ * Maximum packet length.
+ */
+#ifndef PJSIP_MAX_PKT_LEN
+#   define PJSIP_MAX_PKT_LEN            1500
 #endif
 
@@ -85 +128 @@
 /* Transport related constants. */
 
-#define PJSIP_MAX_PKT_LEN               1500
 #define PJSIP_POOL_RDATA_LEN            4000
 #define PJSIP_POOL_RDATA_INC            4000
@@ -142 +184 @@
 //#define PJSIP_T2_TIMEOUT      60000
 
-/* T1 timeout value. */
+/** Transaction T1 timeout value. */
 #if !defined(PJSIP_T1_TIMEOUT)
 #  define PJSIP_T1_TIMEOUT      500
 #endif
 
-/* T2 timeout value. */
+/** Transaction T2 timeout value. */
 #if !defined(PJSIP_T2_TIMEOUT)
 #  define PJSIP_T2_TIMEOUT      4000
 #endif
 
-/* Completed timer for non-INVITE */
+/** Transaction completed timer for non-INVITE */
 #if !defined(PJSIP_T4_TIMEOUT)
 #  define PJSIP_T4_TIMEOUT      5000
 #endif
 
-/* Completed timer for INVITE */
+/** Transaction completed timer for INVITE */
 #if !defined(PJSIP_TD_TIMEOUT)
 #  define PJSIP_TD_TIMEOUT      32000
@@ -167 +209 @@
  */
 
-/*
+/**
  * If this flag is set, the stack will keep the Authorization/Proxy-Authorization
  * headers that are sent in a cache. Future requests with the same realm and
@@ -183 +225 @@
 #endif
 
-/*
+/**
  * If this flag is set, the stack will proactively send Authorization/Proxy-
  * Authorization header for next requests. If next request has the same method
@@ -204 +246 @@
 #endif
 
-/*
+/**
  * Support qop="auth" directive.
  * This option also requires client to cache the last challenge offered by
@@ -216 +258 @@
 
 
+/**
+ * @}
+ */
+
 #include <pj/config.h>