Changeset 4672 for pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/siptypes.hpp

Timestamp:

Dec 4, 2013 3:01:20 AM (10 years ago)

Author:

bennylp

Message:

Re #1519: doxygen fixes and other minor fixes

File:

• pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/siptypes.hpp (modified) (11 diffs)

pjproject/branches/projects/pjsua2/pjsip/include/pjsua2/siptypes.hpp

@@ -30 +30 @@
 #include <vector>
 
-/**
- * @defgroup PJSUA2_TYPES Data structure
- * @ingroup PJSUA2_Ref
- * @{
- */
-
 /** PJSUA2 API is inside pj namespace */
 namespace pj
@@ -41 +35 @@
 
 /**
+ * @defgroup PJSUA2_SIP_Types SIP Types
+ * @ingroup PJSUA2_DS
+ * @{
+ */
+
+/**
  * Credential information. Credential contains information to authenticate
  * against a service.
@@ -75 +75 @@
     /*
      * Digest AKA credential information. Note that when AKA credential
-     * is being used, the \a data field of this #pjsip_cred_info is
+     * is being used, the \a data field of this pjsip_cred_info is
      * not used, but it still must be initialized to an empty string.
-     * Please see \ref PJSIP_AUTH_AKA_API for more information.
+     * Please see PJSIP_AUTH_AKA_API for more information.
      */
 
@@ -146 +146 @@
 
     /**
-     * TLS protocol method from #pjsip_ssl_method.
+     * TLS protocol method from pjsip_ssl_method.
      *
      * Default is PJSIP_SSL_UNSPECIFIED_METHOD (0), which in turn will
@@ -166 +166 @@
      * verification result:
      * - If \a verifyServer is disabled, TLS transport will just notify
-     *   the application via #pjsip_tp_state_callback with state
+     *   the application via pjsip_tp_state_callback with state
      *   PJSIP_TP_STATE_CONNECTED regardless TLS verification result.
      * - If \a verifyServer is enabled, TLS transport will be shutdown
@@ -173 +173 @@
      *   error, otherwise PJSIP_TP_STATE_CONNECTED will be notified.
      *
-     * In any cases, application can inspect #pjsip_tls_state_info in the
+     * In any cases, application can inspect pjsip_tls_state_info in the
      * callback to see the verification detail.
      *
@@ -184 +184 @@
      * verification result:
      * - If \a verifyClient is disabled, TLS transport will just notify
-     *   the application via #pjsip_tp_state_callback with state
+     *   the application via pjsip_tp_state_callback with state
      *   PJSIP_TP_STATE_CONNECTED regardless TLS verification result.
      * - If \a verifyClient is enabled, TLS transport will be shutdown
@@ -191 +191 @@
      *   error, otherwise PJSIP_TP_STATE_CONNECTED will be notified.
      *
-     * In any cases, application can inspect #pjsip_tls_state_info in the
+     * In any cases, application can inspect pjsip_tls_state_info in the
      * callback to see the verification detail.
      *
@@ -382 +382 @@
     string                  info;
 
-    /** Transport flags (see #pjsip_transport_flags_e). */
+    /** Transport flags (see pjsip_transport_flags_e). */
     unsigned                flags;
 
@@ -860 +860 @@
 /* Utilities */
 #ifndef SWIG
+//! @cond Doxygen_Suppress
 void readIntVector( ContainerNode &node,
                     const string &array_name,
@@ -876 +877 @@
                      const string &array_name,
                      const SipHeaderVector &headers) throw(Error);
+//! @endcond
 #endif // SWIG
 
+/**
+ * @}  PJSUA2
+ */
+
 } // namespace pj
 
-/**
- * @}  PJSUA2
- */
-