Changeset 515 for pjproject/trunk/pjsip/include/pjsip/sip_parser.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_parser.h (modified) (8 diffs)

pjproject/trunk/pjsip/include/pjsip/sip_parser.h

@@ -32 +32 @@
 
 /**
- * @defgroup PJSIP_PARSER SIP Message Parser
- * @ingroup PJSIP
+ * @defgroup PJSIP_PARSER Parser
+ * @ingroup PJSIP_MSG
+ * @brief Message and message elements parsing.
  * @{
  */
@@ -67 +68 @@
 typedef struct pjsip_parser_err_report
 {
+    /** Standard header fields. */
     PJ_DECL_LIST_MEMBER(struct pjsip_parser_err_report);
     int         except_code;    /**< Error exception (e.g. PJSIP_SYN_ERR_EXCEPTION) */
@@ -135 +137 @@
  * @param hname         The header name registered.
  * @param hshortname    The short header name registered, or NULL.
+ * @param fptr          Previously registered function to parse the header.
  *
  * @return              zero if unregistration was successfull.
@@ -186 +189 @@
 PJ_DECL(pjsip_uri*) pjsip_parse_uri( pj_pool_t *pool, 
                                      char *buf, pj_size_t size,
-                                     unsigned option);
+                                     unsigned options);
 
 /**
@@ -238 +241 @@
  * @param buf           The input buffer, which must be NULL terminated.
  * @param size          The buffer size.
+ * @param is_datagram   Put non-zero if transport is datagram oriented.
  * @param msg_size      [out] If message is valid, this parameter will contain
  *                      the size of the SIP message (including body, if any).
@@ -279 +283 @@
  * however is optional for the last header.
  *
- * @param pool the pool.
- * @param buf the input text to parse.
- * @param size the text length.
- * @param hlist the header list to store the parsed headers. This list must
- *              have been initialized before calling this function.
- * @return zero if successfull, or -1 if error is encountered. Upon error,
- *              the \a hlist argument MAY contain successfully parsed headers.
+ * @param pool          the pool.
+ * @param input         the input text to parse.
+ * @param size          the text length.
+ * @param hlist         the header list to store the parsed headers. 
+ *                      This list must have been initialized before calling 
+ *                      this function.
+ * @return              zero if successfull, or -1 if error is encountered. 
+ *                      Upon error, the \a hlist argument MAY contain 
+ *                      successfully parsed headers.
  */
 PJ_DECL(pj_status_t) pjsip_parse_headers( pj_pool_t *pool,
                                           char *input, pj_size_t size,
                                           pj_list *hlist );
+
+
+/**
+ * @}
+ */
 
 
@@ -317 +328 @@
  * Various string constants.
  */
-extern const pj_str_t pjsip_USER_STR,
-                      pjsip_METHOD_STR,
-                      pjsip_TRANSPORT_STR,
-                      pjsip_MADDR_STR,
-                      pjsip_LR_STR,
-                      pjsip_SIP_STR,
-                      pjsip_SIPS_STR,
-                      pjsip_TEL_STR,
-                      pjsip_BRANCH_STR,
-                      pjsip_TTL_STR,
-                      pjsip_PNAME_STR,
-                      pjsip_Q_STR,
-                      pjsip_EXPIRES_STR,
-                      pjsip_TAG_STR;
+extern const pj_str_t pjsip_USER_STR,       /**< "user" string constant.    */
+                      pjsip_METHOD_STR,     /**< "method" string constant   */
+                      pjsip_TRANSPORT_STR,  /**< "transport" string const.  */
+                      pjsip_MADDR_STR,      /**< "maddr" string const.      */
+                      pjsip_LR_STR,         /**< "lr" string const.         */
+                      pjsip_SIP_STR,        /**< "sip" string constant.     */
+                      pjsip_SIPS_STR,       /**< "sips" string constant.    */
+                      pjsip_TEL_STR,        /**< "tel" string constant.     */
+                      pjsip_BRANCH_STR,     /**< "branch" string constant.  */
+                      pjsip_TTL_STR,        /**< "ttl" string constant.     */
+                      pjsip_RECEIVED_STR,   /**< "received" string const.   */
+                      pjsip_Q_STR,          /**< "q" string constant.       */
+                      pjsip_EXPIRES_STR,    /**< "expires" string constant. */
+                      pjsip_TAG_STR,        /**< "tag" string constant.     */
+                      pjsip_RPORT_STR;      /**< "rport" string const.      */
+
 
 /*
@@ -347 +360 @@
 void pjsip_parse_end_hdr_imp ( pj_scanner *scanner );
 
-/**
- * @}
- */
-
 PJ_END_DECL