sip: updated documentation

darcs-hash:20070920173859-65a35-531c007f97fa1e5a3187527fce608ab1d8e14f87.gz

libsofia-sip-ua/sip/sip_basic.c

@@ -811,7 +811,7 @@ issize_t sip_name_addr_e(char b[], isize_t bsiz,
  *
  * @retval Size of duplicated name-addr-params construct, including base offset.
  *
- * @NEW_1_12_7
+ * @NEW_1_12_7.
  */
 isize_t sip_name_addr_xtra(char const *display, url_t const *addr,
 			   msg_param_t const params[],
@@ -836,7 +836,7 @@ isize_t sip_name_addr_xtra(char const *display, url_t const *addr,
  *
  * @retval End of the memory area used.
  *
- * @NEW_1_12_7
+ * @NEW_1_12_7.
  */
 char *sip_name_addr_dup(char const **d_display, char const *display,
 			url_t *d_addr, url_t const *addr,

libsofia-sip-ua/sip/sip_extra.c

@@ -241,7 +241,7 @@ issize_t sip_error_info_e(char b[], isize_t bsiz, sip_header_t const *h, int f)
  * };
  * @endcode
  *
- * @NEW_1_12_7
+ * @NEW_1_12_7.
  */
 
 msg_hclass_t sip_alert_info_class[] =

libsofia-sip-ua/sip/sip_parser.c

@@ -90,7 +90,7 @@ msg_mclass_t const *sip_default_mclass(void)
  * @retval 0 when successful
  * @retval -1 upon an error
  *
- * @NEW_1_12_7
+ * @NEW_1_12_7.
  */
 int sip_update_default_mclass(msg_mclass_t const *mclass)
 {
@@ -109,7 +109,7 @@ int sip_update_default_mclass(msg_mclass_t const *mclass)
  *
  * @return Pointer to extended mclass, or NULL upon an error.
  *
- * @NEW_1_12_7
+ * @NEW_1_12_7.
  */
 msg_mclass_t *sip_extend_mclass(msg_mclass_t *input)
 {

libsofia-sip-ua/sip/sip_parser.docs

@@ -56,7 +56,7 @@
  */
 
 #ifndef SIP_H
-#include <sip.h>
+#include <sofia-sip/sip.h>
 #endif
 
 /**@ingroup sip_also

libsofia-sip-ua/sip/sip_pref_util.c

@@ -543,12 +543,12 @@ sip_contact_t *sip_contact_immunize(su_home_t *home, sip_contact_t const *m)
  * 
  * @retval -1 if the contact is rejected
  * @retval 1000 if contact is immune to caller preferences
- * @retval 0..1000 reflecting @RFC3481 score in 0.000 - 1.000.
+ * @retval 0..1000 reflecting @RFC3841 score in 0.000 - 1.000.
  *
  * @sa sip_q_value(),
  * sip_contact_accept(), sip_contact_reject(), sip_contact_is_immune(),
  * sip_contact_immunize(), sip_is_callerpref(), sip_prefs_matching(),
- * @RFC3481, @AcceptContact, @RejectContact, @Contact
+ * @RFC3841, @AcceptContact, @RejectContact, @Contact
  */
 int sip_contact_score(sip_contact_t const *m,
 		      sip_accept_contact_t const *ac,

libsofia-sip-ua/sip/sofia-sip/sip.h

@@ -107,7 +107,7 @@ typedef msg_time_t sip_time_t;
 /** Latest time that can be expressed with #sip_time_t. @HIDE */
 #define SIP_TIME_MAX ((sip_time_t)MSG_TIME_MAX)
 
-/** SIP message object. */
+/** Structure for accessing parsed SIP headers. */
 typedef struct sip_s                sip_t;
 
 /** Any SIP header - union of all possible SIP headers. */
@@ -409,7 +409,7 @@ struct sip_accept_s
 /**@ingroup sip_allow
  * @brief Structure for @Allow header field.
  *
- * @NEW_1_12_5 (before used struct msg_list_s with @Allow).
+ * @NEW_1_12_5. (Before used struct msg_list_s with @Allow).
  */
 struct sip_allow_s
 {
@@ -417,7 +417,7 @@ struct sip_allow_s
   msg_list_t        *k_next;	    /**< Link to next */
   msg_param_t       *k_items;	    /**< List of allowed items */
   uint32_t           k_bitmap;	    /**< Bitmap of allowed methods. 
-				       @NEW_1_12_5 */
+				       @NEW_1_12_5. */
 };
 
 /**@ingroup sip_authentication_info
@@ -573,7 +573,7 @@ struct sip_min_expires_s
 };
 
 /**@ingroup sip_rack
- * @brief Structure for @b Rack header.
+ * @brief Structure for @RAck header.
  */
 struct sip_rack_s
 {

libsofia-sip-ua/sip/sofia-sip/sip_header.h

@@ -352,7 +352,7 @@ int sip_has_feature(msg_list_t const *supported, char const *feature);
 SOFIAPUBFUN int sip_is_allowed(sip_allow_t const *allow, 
 			       sip_method_t method, char const *name);
 
-/** Check if the well-known method is listed in @Allow header. @NEW_1_12_6 */
+/** Check if the well-known method is listed in @Allow header. @NEW_1_12_6. */
 #define SIP_IS_ALLOWED(allow, method) \
   (sip_method_unknown < (method) && (method) < 32 && \
    (allow) && ((allow)->k_bitmap & (1 << (method))) != 0)
@@ -450,7 +450,7 @@ enum sip_bad_mask {
 
   /** Bit marking essential headers for PUBLISH servers and clients.
    *
-   * @SIPEtag, and @SIPIfMatch.
+   * @SIPETag, and @SIPIfMatch.
    * 
    * @sa @RFC3903.
    */

libsofia-sip-ua/sip/sofia-sip/sip_tag.h.in

@@ -153,7 +153,7 @@ siptag_header_vr(sip_header_t const **vp)
  * Macro is used to include a tag item containing an unknown extension
  * header in the tag list, e.g.,
  * @code
- * SIPTAG_HEADER_STR("Remote-Party-ID: +358718008000")
+ * SIPTAG_HEADER_STR("P-Alternative-URL: <+358718008000>")
  * @endcode
  *
  * It is also possible to include multiple headers at once

libsofia-sip-ua/sip/validator.c

@@ -22,9 +22,10 @@
  *
  */
 
-/**@IFILE validator.c  
+/**@internal @IFILE validator.c  
  *
- * SIP parser tester. This uses output
+ * SIP parser tester. This uses output from tport dump where messages are
+ * separated with Control-K ('\v') from each other.
  *
  * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
  *