Commit 34d8ad9a authored by berge's avatar berge
Browse files

Added some missing T3Doc statements

parent 4557bc85

ttcn/BTP/LibItsBtp_Functions.ttcn

+5 −5
Original line number Original line Diff line number Diff line
@@ -110,7 +110,7 @@ 
        

        

        /**

        /**

         * @desc Gets the BTP source port of the IUT.

         * @desc Gets the BTP source port of the IUT.

         * @return 

         * @return BTP source port ID

         */

         */

        function f_getBtpSrcPort() return BtpPortId {

        function f_getBtpSrcPort() return BtpPortId {

            return PX_SOURCE_PORT;

            return PX_SOURCE_PORT;
@@ -118,7 +118,7 @@ 
        

        

        /**

        /**

         * @desc Gets the BTP destination port of the IUT.

         * @desc Gets the BTP destination port of the IUT.

         * @return 

         * @return BTP destination port ID

         */

         */

        function f_getBtpDstPort() return BtpPortId {

        function f_getBtpDstPort() return BtpPortId {

            return PX_DESTINATION_PORT;

            return PX_DESTINATION_PORT;
@@ -126,7 +126,7 @@ 
        

        

        /**

        /**

         * @desc Gets a unknown BTP destination port of the IUT.

         * @desc Gets a unknown BTP destination port of the IUT.

         * @return 

         * @return Unknown BTP destination port ID

         */

         */

        function f_getBtpUnknownDstPort() return BtpPortId {

        function f_getBtpUnknownDstPort() return BtpPortId {

            return PX_UNKNOWN_DESTINATION_PORT;

            return PX_UNKNOWN_DESTINATION_PORT;
@@ -134,7 +134,7 @@ 
        

        

        /**

        /**

         * @desc Gets the BTP destination port info of the IUT.

         * @desc Gets the BTP destination port info of the IUT.

         * @return 

         * @return BTP destination port info

         */

         */

        function f_getBtpDstPortInfo() return BtpPortId {

        function f_getBtpDstPortInfo() return BtpPortId {

            return PX_DESTINATION_PORT_INFO;

            return PX_DESTINATION_PORT_INFO;
@@ -142,7 +142,7 @@ 
        

        

        /**

        /**

         * @desc Gets the BTP payload to use.

         * @desc Gets the BTP payload to use.

         * @return 

         * @return BTP payload

         */

         */

        function f_getBtpPayload() return BtpPayload {

        function f_getBtpPayload() return BtpPayload {

            return PX_PAYLOAD;

            return PX_PAYLOAD;

ttcn/BTP/LibItsBtp_Templates.ttcn

+2 −3
Original line number Original line Diff line number Diff line
@@ -74,9 +74,8 @@ module LibItsBtp_Templates { 
            }

            }

            

            

            /**

            /**

             * @desc Generate a BTP B packet

             * @desc Upper Tester template for checking that BTP payload has been transmitted to upper layer

             * @param p_destPort      The destination port

             * @param p_payload Payload to be checked

             * @param p_destPortInfo  The destination port information

             */

             */

            template (value) UtEvent m_checkPayload(in BtpPayload p_payload) := {

            template (value) UtEvent m_checkPayload(in BtpPayload p_payload) := {

                utBtpEvent := {

                utBtpEvent := {

ttcn/CAM/LibItsCam_Templates.ttcn

+3 −3
Original line number Original line Diff line number Diff line
@@ -17,7 +17,7 @@ module LibItsCam_Templates { 
    group camPrimitives {

    group camPrimitives {

        

        

        /**

        /**

         * @desc    Send template for CAM Message (CamPort Primitive)

         * @desc    Receive template for CAM Message (CamPort Primitive)

         * @param   p_camMsg CAM Message to be sent

         * @param   p_camMsg CAM Message to be sent

         */

         */

        template CamInd mw_camInd (

        template CamInd mw_camInd (
@@ -248,7 +248,7 @@ module LibItsCam_Templates { 
    }

    }





    /**

    /**

     * @desc    Receive template for CAM PDU for vehicle  

     * @desc    Receive template for CAM PDU for any vehicle  

     * @see     mw_camMsg_any

     * @see     mw_camMsg_any

     */

     */

    template CamPdu mw_camMsg_anyVehicle 

    template CamPdu mw_camMsg_anyVehicle
@@ -335,7 +335,7 @@ module LibItsCam_Templates { 
    };

    };

        

        

    /**

    /**

     * @desc    Receive template for CAM PDU for vehicle

     * @desc    Receive template for CAM PDU for basic vehicle

     * @see     mw_camMsg_anyVehicle

     * @see     mw_camMsg_anyVehicle

     */

     */

    template CamPdu mw_camMsg_basicVehicle 

    template CamPdu mw_camMsg_basicVehicle

ttcn/Common/LibItsCommon_Functions.ttcn

+1 −3
Original line number Original line Diff line number Diff line
@@ -49,7 +49,6 @@ module LibItsCommon_Functions { 
        /**

        /**

         * @desc    Triggers event from the application layer

         * @desc    Triggers event from the application layer

         * @param   p_event The event to trigger.

         * @param   p_event The event to trigger.

         * @return 

         */

         */

        function f_utTriggerEvent(template (value) UtEvent p_event) runs on ItsAdapterComponent {

        function f_utTriggerEvent(template (value) UtEvent p_event) runs on ItsAdapterComponent {

            var template (value) UtTrigger v_utMsg := { p_event };

            var template (value) UtTrigger v_utMsg := { p_event };
@@ -61,7 +60,6 @@ module LibItsCommon_Functions { 
         * @desc Checks that the event was indicated at the application layer

         * @desc Checks that the event was indicated at the application layer

         * @param p_event The event to check.

         * @param p_event The event to check.

         * @param   p_discard The event should not appear. Default value: FALSE.

         * @param   p_discard The event should not appear. Default value: FALSE.

         * @return 

         */

         */

        function f_utCheckEvent(template (value) UtEvent p_event, boolean p_discard) runs on ItsAdapterComponent {

        function f_utCheckEvent(template (value) UtEvent p_event, boolean p_discard) runs on ItsAdapterComponent {

            var template (value) UtCheck v_utMsg := { p_event };

            var template (value) UtCheck v_utMsg := { p_event };
@@ -171,7 +169,7 @@ module LibItsCommon_Functions { 
    group externalFunctions {

    group externalFunctions {

        

        

        /**

        /**

         * @desc    Gets the current time    

         * @desc    This external function gets the current time    

         * @return  Timestamp - current time in Epoch format

         * @return  Timestamp - current time in Epoch format

         */

         */

        external function fx_getCurrentTime() return TimeStamp;

        external function fx_getCurrentTime() return TimeStamp;

ttcn/DENM/LibItsDenm_Functions.ttcn

+3 −4
Original line number Original line Diff line number Diff line
@@ -104,7 +104,7 @@ module LibItsDenm_Functions { 
        

        

        /**

        /**

         * @desc Brings the IUT into an initial state.

         * @desc Brings the IUT into an initial state.

         * @return 

         * @return FncRetCode 

         */

         */

        function f_prInitialState() runs on ItsFa return FncRetCode {

        function f_prInitialState() runs on ItsFa return FncRetCode {

            var FncRetCode v_ret := e_success;

            var FncRetCode v_ret := e_success;
@@ -182,10 +182,9 @@ module LibItsDenm_Functions { 
        }

        }

        

        

        /**

        /**

         * @desc Awaits a DEN message

         * @desc Awaits a DEN message and returns it

         * @param p_rcvMsg The expected message to be received.

         * @param p_rcvMsg The expected message to be received.

         * @param p_rcvdMsg The received message - OUT.

         * @param p_rcvdMsg The received message - OUT.

         * @return 

         */

         */

        function f_awaitDenMessageOut(in template (present) DenmInd p_rcvMsg, out DenmInd p_rcvdMsg) runs on ItsFa {

        function f_awaitDenMessageOut(in template (present) DenmInd p_rcvMsg, out DenmInd p_rcvdMsg) runs on ItsFa {
@@ -210,7 +209,7 @@ module LibItsDenm_Functions { 
            

            

            /**

            /**

             * @desc Gets IUT's default event duration

             * @desc Gets IUT's default event duration

             * @return 

             * @return Default expiry time of DENM events

             */

             */

            function f_getIutDefaultEventDuration() return TimeStamp {

            function f_getIutDefaultEventDuration() return TimeStamp {

                return PICS_DEFAULT_EXPIRY_TIME;

                return PICS_DEFAULT_EXPIRY_TIME;