Updated documentation of SIP headers.

darcs-hash:20051219122124-65a35-96a6593920bbb2d79e27c1cf7b9a5318278bbeda.gz

libsofia-sip-ua/sip/sip_event.c

@@ -215,9 +215,9 @@ int sip_allow_events_add(su_home_t *home,
 
 /**@SIP_HEADER sip_subscription_state Subscription-State Header
  *
- * The Subscription-State header is used to indicate which State a
- * Application, associated with a certain dialogue, is in. Its syntax is
- * defined in [Events4.2.4] @RFC3265 as follows:
+ * The Subscription-State header is used to indicate in which state a
+ * subscription is. Its syntax is defined in @RFC3265 section 4.2.4 as
+ * follows:
  * 
  * @code
  *    Subscription-State   = "Subscription-State" HCOLON substate-value
@@ -250,13 +250,14 @@ int sip_allow_events_add(su_home_t *home,
  * @code
  * typedef struct sip_subscription_state_s
  * {
- *   sip_common_t        ss_common[1];
- *   sip_unknown_t      *ss_next;
- *   char const         *ss_substate;        // State value
- *   msg_param_t const  *ss_params;          // List of parameters
- *   msg_param_t         ss_reason;          // Value of reason parameter
- *   msg_param_t         ss_expires;         // Value of expires parameter
- *   msg_param_t         ss_retry_after;     // Value of retry-after parameter
+ *   sip_common_t       ss_common[1];
+ *   sip_unknown_t     *ss_next;
+ *   // Subscription state: "pending", "active" or "terminated"
+ *   char const        *ss_substate;        
+ *   msg_param_t const *ss_params;      // List of parameters
+ *   msg_param_t        ss_reason;      // Reason of terminating 
+ *   msg_param_t        ss_expires;     // Subscription lifetime in seconds
+ *   msg_param_t        ss_retry_after; // Value of retry-after parameter
  * } sip_subscription_state_t;
  * @endcode
  */

libsofia-sip-ua/sip/sip_extra.c

@@ -25,9 +25,9 @@
 /**@CFILE sip_extra.c
  * @brief Non-critical SIP headers
  * 
- * This file contains implementation of @b Also, @b Call-Info, @b
- * Error-Info, @b Hide, @b Organization, @b Priority, @b Retry-After, @b
- * Server, @b Subject, @b Timestamp, and @b User-Agent headers.
+ * This file contains implementation of @b Call-Info, @b Error-Info,
+ * @b Organization, @b Priority, @b Retry-After, @b Server, @b Subject,
+ * @b Timestamp, and @b User-Agent headers.
  * 
  * @author Pekka Pessi <Pekka.Pessi@nokia.com>.
  * 
@@ -200,8 +200,9 @@ int sip_error_info_e(char b[], int bsiz, sip_header_t const *h, int f)
 
 /**@SIP_HEADER sip_in_reply_to In-Reply-To Header
  * 
- * The @b In-Reply-To request header field enumerates the call-IDs that this
- * call references or returns. Its syntax is defined in [S10.26] as follows:
+ * The @b In-Reply-To request header field enumerates the @b Call-IDs that
+ * this call references or returns. Its syntax is defined in [S10.26] as
+ * follows:
  * 
  * @code
  *    In-Reply-To  =  "In-Reply-To" HCOLON callid *(COMMA callid)