Commit 9daa5aff authored by schulzs's avatar schulzs
Browse files

Updated module documentation and corrected documentation comments

parent 11f4f2d2
Loading
Loading
Loading
Loading
+49 −43
Original line number Diff line number Diff line
/*
/**
 *  @author   STF 346
 *  @version  $Id$
 *	@desc		This module provides the SDP type system for SIP tests.
 *              Module become from STF306 and STF334-336
 *	@desc     This module defines message, attribute, structured and simple 
 *            SDP types as well constants used by LipSip constructs. <br>
 *            Note that any changes made to the definitions in this module
 *            may be overwritten by future releases of this library
 *            End users are encouraged to contact the distributers of this  
 *            module regarding their modifications or additions
 *  @remark   Adding of new attributes types is ok;
 *            Adding of new optional attributes in @see SDP_attribute type 
 *            is ok;
 *            Existing attribute types shall not be changed or removed -
 *            change requests shall be made to http://t-ort.etsi.org
 */

module LibSip_SDPTypes
@@ -160,10 +169,10 @@ module LibSip_SDPTypes
                SDP_attribute_rtpmap          rtpmap,
                SDP_attribute_rtcp            rtcp,

                // unknown has to be the last else encoding/decoding won't work!
                //*  unknown has to be the last else encoding/decoding won't work!
                SDP_attribute_unknown unknown
            }
        } // group AttributeTypes
        } //*  group AttributeTypes

      type set of SDP_attribute SDP_attribute_list;

@@ -235,10 +244,8 @@ module LibSip_SDPTypes
      }

      type record SDP_time_field{
      // due to the limitation of integer value a charstring shall be used
      // to represent 32 bit long unsigned int
        charstring   start_time,
        charstring   stop_time
        charstring   start_time, //*  field is numeric strings that may not fit into 32-bit signed int
        charstring   stop_time //*  field is numeric strings that may not fit into 32-bit signed int
      }

      type record SDP_repeat{
@@ -267,16 +274,15 @@ module LibSip_SDPTypes

      type record SDP_Origin{
        charstring          user_name,
// the following 2 fields are numeric strings that may not fit into 32-bit signed int
        charstring          session_id,
        charstring          session_version,
        charstring          session_id,//*  field is numeric strings that may not fit into 32-bit signed int
        charstring          session_version, //*  field is numeric strings that may not fit into 32-bit signed int
        charstring          net_type,
        charstring          addr_type,
        charstring          addr
      }

      type set of SDP_contact_tel SDP_phone_list;
    } // group SubTypes
    } //*  group SubTypes


    group MessageTypes
@@ -296,7 +302,7 @@ module LibSip_SDPTypes
        SDP_key             key optional,
        SDP_attribute_list  attributes optional,
        SDP_media_desc_list media_list optional
      }// with { encode "SDPCodec" }
      }
    } //  group MessageTypes
  } //  group Types
 
+14 −5
Original line number Diff line number Diff line
/*
/**
 *	@author   STF 346
 *  @version  $Id$
 *	@desc		This module provides the types and constants used by the test component 
 *              for SIP tests. Module become from STF306 and STF334-336
 *	@desc     This module defines message, header, structured and simple SIP 
 *            types as well constants used by LipSip constructs. <br>
 *            Note that any changes made to the definitions in this module
 *            may be overwritten by future releases of this library
 *            End users are encouraged to contact the distributers of this  
 *            module regarding their modifications or additions
 *  @remark   Adding of new message and header types is ok;
 *            Adding of new optional header fields in @see MessageHeader type 
 *            is ok but should be done at same time as dummy template updates;
 *            Existing message or header types shall not be changed or removed -
 *            change requests shall be made to http://t-ort.etsi.org
 */

module LibSip_SIPTypesAndValues
+234 −226

File changed.

Preview size limit exceeded, changes collapsed.