Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_uri.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_uri.h (modified) (5 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_uri.h

@@ -34 +34 @@
 
 /**
- * @defgroup PJSIP_URL URL Structures
- * @brief SIP Url, tel: Url, and generic URI.
+ * @defgroup PJSIP_URI URI
+ * @brief URI types and manipulations.
  * @ingroup PJSIP_MSG
+ */
+
+/**
+ * @addtogroup PJSIP_URI_PARAM URI Parameter Container
+ * @ingroup PJSIP_URI
+ * @brief Generic parameter elements container.
  * @{
  */
@@ -118 +124 @@
                                          const pj_cis_t *pvalue_unres,
                                          int sep);
+
+/**
+ * @}
+ */
+
+/**
+ * @defgroup PJSIP_URI_GENERIC Generic URI
+ * @ingroup PJSIP_URI
+ * @brief Generic representation for all types of URI.
+ * @{
+ */
 
 /**
@@ -220 +237 @@
 #define PJSIP_URI_SCHEME_IS_TEL(url)    \
     (pj_strnicmp2(pjsip_uri_get_scheme(url), "tel", 3)==0)
+
+
+/**
+ * Generic function to get the URI scheme.
+ * @param uri       the URI object.
+ * @return          the URI scheme.
+ */
+PJ_INLINE(const pj_str_t*) pjsip_uri_get_scheme(const void *uri)
+{
+    return (*((pjsip_uri*)uri)->vptr->p_get_scheme)(uri);
+}
+
+/**
+ * Generic function to get the URI object contained by this URI, or the URI 
+ * itself if it doesn't contain another URI.
+ *
+ * @param uri       the URI.
+ * @return          the URI.
+ */
+PJ_INLINE(void*) pjsip_uri_get_uri(void *uri)
+{
+    return (*((pjsip_uri*)uri)->vptr->p_get_uri)(uri);
+}
+
+/**
+ * Generic function to compare two URIs.
+ *
+ * @param context   Comparison context.
+ * @param uri1      The first URI.
+ * @param uri2      The second URI.
+ * @return          PJ_SUCCESS if equal, or otherwise the error status which
+ *                  should point to the mismatch part.
+ */
+PJ_INLINE(pj_status_t) pjsip_uri_cmp(pjsip_uri_context_e context, 
+                                     const void *uri1, const void *uri2)
+{
+    return (*((const pjsip_uri*)uri1)->vptr->p_compare)(context, uri1, uri2);
+}
+
+/**
+ * Generic function to print an URI object.
+ *
+ * @param context   Print context.
+ * @param uri       The URI to print.
+ * @param buf       The buffer.
+ * @param size      Size of the buffer.
+ * @return          Length printed.
+ */
+PJ_INLINE(int) pjsip_uri_print(pjsip_uri_context_e context,
+                               const void *uri,
+                               char *buf, pj_size_t size)
+{
+    return (*((const pjsip_uri*)uri)->vptr->p_print)(context, uri, buf, size);
+}
+
+/**
+ * Generic function to clone an URI object.
+ *
+ * @param pool      Pool.
+ * @param uri       URI to clone.
+ * @return          New URI.
+ */
+PJ_INLINE(void*) pjsip_uri_clone( pj_pool_t *pool, const void *uri )
+{
+    return (*((const pjsip_uri*)uri)->vptr->p_clone)(pool, uri);
+}
+
+
+
+/**
+ * @}
+ */
+
+/**
+ * @defgroup PJSIP_SIP_URI SIP URI Scheme and Name address
+ * @ingroup PJSIP_URI
+ * @brief SIP URL structure ("sip:" and "sips:")
+ * @{
+ */
 
 
@@ -262 +358 @@
 
 /**
- * Generic function to get the URI scheme.
- * @param uri       the URI object.
- * @return          the URI scheme.
- */
-PJ_INLINE(const pj_str_t*) pjsip_uri_get_scheme(const void *uri)
-{
-    return (*((pjsip_uri*)uri)->vptr->p_get_scheme)(uri);
-}
-
-/**
- * Generic function to get the URI object contained by this URI, or the URI 
- * itself if it doesn't contain another URI.
- *
- * @param uri       the URI.
- * @return          the URI.
- */
-PJ_INLINE(void*) pjsip_uri_get_uri(void *uri)
-{
-    return (*((pjsip_uri*)uri)->vptr->p_get_uri)(uri);
-}
-
-/**
- * Generic function to compare two URIs.
- *
- * @param context   Comparison context.
- * @param uri1      The first URI.
- * @param uri2      The second URI.
- * @return          PJ_SUCCESS if equal, or otherwise the error status which
- *                  should point to the mismatch part.
- */
-PJ_INLINE(pj_status_t) pjsip_uri_cmp(pjsip_uri_context_e context, 
-                                     const void *uri1, const void *uri2)
-{
-    return (*((const pjsip_uri*)uri1)->vptr->p_compare)(context, uri1, uri2);
-}
-
-/**
- * Generic function to print an URI object.
- *
- * @param context   Print context.
- * @param uri       The URI to print.
- * @param buf       The buffer.
- * @param size      Size of the buffer.
- * @return          Length printed.
- */
-PJ_INLINE(int) pjsip_uri_print(pjsip_uri_context_e context,
-                               const void *uri,
-                               char *buf, pj_size_t size)
-{
-    return (*((const pjsip_uri*)uri)->vptr->p_print)(context, uri, buf, size);
-}
-
-/**
- * Generic function to clone an URI object.
- *
- * @param pool      Pool.
- * @param uri       URI to clone.
- * @return          New URI.
- */
-PJ_INLINE(void*) pjsip_uri_clone( pj_pool_t *pool, const void *uri )
-{
-    return (*((const pjsip_uri*)uri)->vptr->p_clone)(pool, uri);
-}
-
-
-/**
  * Create new SIP URL and initialize all fields with zero or NULL.
  * @param pool      The pool.
@@ -345 +375 @@
  * Initialize SIP URL (all fields are set to NULL or zero).
  * @param url       The URL.
+ * @param secure    Create sips URI?
  */
 PJ_DECL(void)  pjsip_sip_uri_init(pjsip_sip_uri *url, int secure);