Fri Aug 8 09:41:49 EDT 2008 Pekka Pessi <first.last@nokia.com>

* nua: updated tag documentation



git-svn-id: http://svn.freeswitch.org/svn/freeswitch/trunk@9279 d0543943-73ff-0310-b7d9-9358b9ac24b2

libs/sofia-sip/.update

@@ -1 +1 @@
-Tue Aug 12 13:07:33 EDT 2008
+Tue Aug 12 13:07:50 EDT 2008

libs/sofia-sip/libsofia-sip-ua/nua/nua.docs

@@ -1126,7 +1126,7 @@ follows:
     <td>
    If there was a failure in SDP negotiation or other failure with media,
    the stack will automatically terminate the call. The BYE follows
-   immediatelhy after the ACK.
+   immediately after the ACK.
 </td></tr>
 <tr><td>C6a</td>
     <td>calling</td>

libs/sofia-sip/libsofia-sip-ua/nua/nua_tag.c

@@ -367,11 +367,11 @@ tag_typedef_t nutag_uicc = STRTAG_TYPEDEF(uicc);
  * - nua_invite()
  *
  * @par Parameter type
- *    int
+ *    int (boolean: nonzero is true, zero is false)
  *
  * @par Values
- *    @c 0   Do not add @AcceptContact \n
+ *    - 0 (false) - Do not add @AcceptContact
- *    @c !=0 Add @AcceptContact with media tags
+ *    - 1 (true) - Add @AcceptContact with media tags
  *
  * Corresponding tag taking reference parameter is NUTAG_MEDIA_FEATURES_REF()
  *
@@ -399,8 +399,8 @@ tag_typedef_t nutag_media_features = BOOLTAG_TYPEDEF(media_features);
  *    int
  *
  * @par Values
- *    @c 0   Do not include methods and media feature paramete \n
+ *    - 0 (false) - Do not include methods and media feature parameters
- *    @c !=0 Include media tags in 
+ *    - 1 (true) - Include media tags in @Contact
  *
  * Corresponding tag taking reference parameter is NUTAG_MEDIA_FEATURES_REF().
  *
@@ -424,11 +424,11 @@ tag_typedef_t nutag_callee_caps = BOOLTAG_TYPEDEF(callee_caps);
  * - nua_invite(), nua_respond()
  *
  * @par Parameter type
- *    int (boolean)
+ *    int (boolean: nonzero is true, zero is false)
  *
  * @par Values
- *    @c 0   False - do not try to use early media \n
+ *    - 0 (false) -  do not try to use early media
- *    @c !=0 True - try to use early media
+ *    - 1 (true) - try to use early media
  *
  * @sa NUTAG_EARLY_ANSWER()
  *
@@ -459,13 +459,18 @@ tag_typedef_t nutag_early_media = BOOLTAG_TYPEDEF(early_media);
  *    nua_respond()
  *
  * @par Parameter type
- *    int (boolean)
+ *    int (boolean: nonzero is true, zero is false)
  *
  * @par Values
- *    @c 0   False \n
+ *    - 0 (false) - include 100rel in all preliminary responses 
- *    @c !=0 True
+ *    - 1 (true) - include 100rel only in 183 responses
+ *
+ * @note 
+ * This tag takes only effect when NUTAG_EARLY_MEDIA(1) has been used, too.
  *
  * Corresponding tag taking reference parameter is NUTAG_ONLY183_100REL_REF().
+ *
+ * @sa 
  */
 tag_typedef_t nutag_only183_100rel = BOOLTAG_TYPEDEF(only183_100rel);
 
@@ -700,7 +705,7 @@ tag_typedef_t nutag_callstate = INTTAG_TYPEDEF(callstate);
  *    #nua_i_state
  *
  * @par Parameter type
- *    boolean
+ *    int (boolean: nonzero is true, zero is false)
  *
  * Corresponding tag taking reference parameter is NUTAG_OFFER_RECV_REF().
  */
@@ -719,7 +724,7 @@ tag_typedef_t nutag_offer_recv = BOOLTAG_TYPEDEF(offer_recv);
  *    #nua_i_state
  *
  * @par Parameter type
- *    boolean
+ *    int (boolean: nonzero is true, zero is false)
  *
  * Corresponding tag taking reference parameter is NUTAG_ANSWER_RECV_REF().
  */
@@ -738,7 +743,7 @@ tag_typedef_t nutag_answer_recv = BOOLTAG_TYPEDEF(answer_recv);
  *    #nua_i_state
  *
  * @par Parameter type
- *    boolean
+ *    int (boolean: nonzero is true, zero is false)
  *
  * Corresponding tag taking reference parameter is NUTAG_OFFER_SENT_REF().
  */
@@ -980,8 +985,8 @@ tag_typedef_t nutag_invite_timer = UINTTAG_TYPEDEF(invite_timer);
  *    unsigned int
  *
  * @par Values
- *    @c 0  disable \n
+ *    - 0  disable
- *    @c >0 interval in seconds
+ *    - >0 interval in seconds
  *
  * Corresponding tag taking reference parameter is NUTAG_SESSION_TIMER_REF().
  *
@@ -1211,8 +1216,8 @@ tag_typedef_t nutag_autoalert = BOOLTAG_TYPEDEF(autoAlert);
  *    int (boolean)
  *
  * @par Values
- *    @c 0    No automatic sending of "200 Ok" \n
+ *    - 0 (false) - No automatic sending of "200 Ok"
- *    @c !=0 "200 Ok" sent automatically
+ *    - 1 (true) - "200 Ok" sent automatically
  *
  * Corresponding tag taking reference parameter is NUTAG_AUTOANSWER_REF().
  *
@@ -2812,8 +2817,8 @@ tag_typedef_t nutag_dialog = UINTTAG_TYPEDEF(dialog);
  *    int (boolean)
  *
  * @par Values
- *    @c 0   False \n
+ *    - 0 (false) - pass only #nua_r_shutdown events to application during shutdown
- *    @c !=0 True
+ *    - 1 (true) - pass all events to application during shutdown
  *
  * Corresponding tag taking reference parameter is NUTAG_SHUTDOWN_EVENTS_REF().
  *