Commit 57076cf3 authored by saiu's avatar saiu
Browse files

I've fixed the @desc statements and have added new comments

parent 34a12c15
Loading
Loading
Loading
Loading
+24 −19
Original line number Diff line number Diff line
/*
/**
 *	@author 	STF 369
 *  @version    $Id$
 *	@desc		This module provides the functions used by the test component 
@@ -23,7 +23,7 @@ module AtsNIT_SipSip_Steps {
	group headerFunctions {
		
		/**
		 * @desc extract the contact uri
		 * @desc This function extracts the contact URI from the contact header field
		 * @param p_contact contact header
		 * @return contact uri
		 */
@@ -44,7 +44,7 @@ module AtsNIT_SipSip_Steps {
    	
    	/**
    	 * 
    	 * @desc extract the tag values. ex To tag, From tag
    	 * @desc This function extracts the tag parameter values from the FROM or TO header fields (FROM-tag, TO-tag)
    	 * @param p_paramList header info
    	 * @param p_name header name
    	 * @return tag value
@@ -81,7 +81,7 @@ module AtsNIT_SipSip_Steps {
    	group sessionModification {
    		
    		/**
			 * @desc Saves the current dialog infomation
			 * @desc This function saves the current dialog infomation
			 * @return Dialog infomation
			 */
    		function f_saveSession() runs on ImsComponent return SessionDialog {
@@ -103,7 +103,7 @@ module AtsNIT_SipSip_Steps {
    		}
    		
    		/**
			 * @desc Load a given dialog parameters
			 * @desc This function loads a given dialog parameters (previously stored)
			 * @param p_dialog dialog parameters
			 */
    		function f_loadSession(in SessionDialog p_dialog) runs on ImsComponent {
@@ -125,7 +125,7 @@ module AtsNIT_SipSip_Steps {
	group callFunctions {
		
		/**
		 * @desc Establish a call to given user profile.
		 * @desc This function establishes a new call to given user profile.
		 * @param p_cSeq_s CSeq number
		 * @param p_to_user user profile
		 */
@@ -173,7 +173,7 @@ module AtsNIT_SipSip_Steps {
		
		/**
		 * 
		 * @desc Accept a incomming call 
		 * @desc This function accepts a new incoming call 
		 */
		function f_acceptCall() runs on ImsComponent {
			// await INVITE 
@@ -207,6 +207,11 @@ module AtsNIT_SipSip_Steps {
			f_awaitingACK(mw_ACK_Request_Base(vc_callId));
		}
		
		/**
		 * 
		 * @desc This function accepts a new incoming call (this function is used in ETC testcases)
		 * @param	p_referredBy user sip uri
		 */
		function f_acceptCall4ECT(in SipUrl p_referredBy) runs on ImsComponent {
			
			// await INVITE 
@@ -242,7 +247,7 @@ module AtsNIT_SipSip_Steps {
		
		/**
		 * 
		 * @desc holds a active call 
		 * @desc This function sends a re-INVITE request to put on hold a active call 
		 */
		function f_holdCall() runs on ImsComponent {
			
@@ -286,7 +291,7 @@ module AtsNIT_SipSip_Steps {
		
		/**
		 * 
		 * @desc accept call hold 
		 * @desc This function accepts a re-INVITE request to put on hold a active call
		 */
		function f_acceptHoldCall() runs on ImsComponent {
			// await INVITE
@@ -314,7 +319,7 @@ module AtsNIT_SipSip_Steps {
		}
		
		/**
		 * @desc Creates a new confernece
		 * @desc This function creates a new conference by sending a INVITE to a conference FOKUS
		 * @param p_cSeq_s CSeq number
		 * @param p_profile conference profile
		 * @param p_subscribe enables subscription of conference state
@@ -369,7 +374,7 @@ module AtsNIT_SipSip_Steps {
		}

		/**
			* @desc subscribes Conference event package
			* @desc This function subscribes a Conference event package by sending a SUBSCRIBE request to a conference FOKUS
			* @param p_cSeq_s CSeq number
			* @param p_profile is conference URI
			*/
@@ -404,7 +409,7 @@ module AtsNIT_SipSip_Steps {
		}
		
		/**
		 * @desc invites a user to a conference with an ACK for the 202 message
		 * @desc This function sends a REFER request to a user (this function sends an ACK request after receving the 202 response)
		 * @param p_cSeq CSeq number
		 * @param p_to_user user
		 * @param p_conferenceUri conference uri
@@ -541,7 +546,7 @@ module AtsNIT_SipSip_Steps {
		}
		
		/**
		 * @desc invites a user to a conference
		 * @desc This function invites a user to join a conference by sending a REFER request to the user
		 * @param p_cSeq CSeq number
		 * @param p_to_user user
		 * @param p_conferenceUri conference uri
@@ -591,8 +596,8 @@ module AtsNIT_SipSip_Steps {
			));
		}
		
		/* 
		 * @desc invites a user to a conference
		/**
		 * @desc This function invites a user to join a conference by sending a REFER request to a conference FOKUS
		 * @param p_cSeq CSeq number
		 * @param p_to_user user
		 * @param p_conferenceUri conference uri
@@ -642,8 +647,8 @@ module AtsNIT_SipSip_Steps {
		}
		
		
		/* 
		 * @desc invites a user to a conference
		/** 
		 * @desc This function invites a user to join a conference by sending a REFER request (with the replaces method into the refer-to header field) to a conference FOKUS
		 * @param p_cSeq CSeq number
		 * @param p_to_user user
		 * @param p_conferenceUri conference uri
@@ -704,7 +709,7 @@ module AtsNIT_SipSip_Steps {
		
		/**
		 * 
		 * @desc join a conference  
		 * @desc This function accepts an incoming request to join a conference  
		 * @param p_cSeq CSeq number
		 * @param p_profile conference profile
		 */
@@ -792,7 +797,7 @@ module AtsNIT_SipSip_Steps {
		}
		
		/**
		 * @desc Accepts invitation for conference call.
		 * @desc This function accepts an incoming request to join a conference from the confrence FOKUS
		 */
		function f_acceptConference() runs on ImsComponent {
			// await INVITE