7.1.2

Author: quantum-leaps

doxygen/qutest_ref.dox

@@ -138,54 +138,53 @@ python3 $(QTOOLS)/qspy/py/qutest.py *.py DEBUG localhost:7701 6605
 @endverbatim
 
 
-
 @section qutest_dsl QUTest™ Testing DSL
 The Python module <span class="img file_py">qtools/qspy/py/qutest.py</span> defines a small Domain Specific Language (DSL) for writing test scripts in Python. The structure of this DSL is very simple. Each test script consists of two sections:
 
 
 @subsection qutest_dsl-preamble Preamble
 The "preamble" section of a test script file specifies include scripts and defines callback functions common to all tests in this file. It can contain the following functions:
 
-- include()
-- on_reset()
-- on_setup()
-- on_teardown().
+- @ref qutest_dsl::include()     "include()"
+- @ref qutest_dsl::on_reset()    "on_reset()"
+- @ref qutest_dsl::on_setup()    "on_setup()"
+- @ref qutest_dsl::on_teardown() "on_teardown()"
 
 The `on_...()` callback functions can call any of the @ref qutest_dsl-commands "test commands".
 
 
 @subsection qutest_dsl-tests Tests
 The "tests" section of a test script file contains the actual tests. Each test starts with the test() command and can contain any number of the @ref qutest_dsl-commands "test commands". The test continues until another test() command, or the skip() command.
 
-- test()
-- skip().
+- @ref qutest_dsl::test() "test()"
+- @ref qutest_dsl::skip() "skip()"
 
 
 @subsection qutest_dsl-commands Commands
 The commands that you can place in the tests (as well as inside the callback functions) are:
 
-- expect()
-- glb_filter()
-- loc_filter()
-- ao_filter()
-- current_obj()
-- query_curr()
-- tick()
-- expect_pause()
-- continue_test()
-- command()
-- init()
-- dispatch()
-- post()
-- publish()
-- probe()
-- peek()
-- poke()
-- fill()
-- pack()
-- test_file()
-- test_dir()
-- last_rec().
+- @ref qutest_dsl::command()      "command()"
+- @ref qutest_dsl::expect()       "expect()"
+- @ref qutest_dsl::glb_filter()   "glb_filter()"
+- @ref qutest_dsl::loc_filter()   "loc_filter()"
+- @ref qutest_dsl::ao_filter()    "ao_filter()"
+- @ref qutest_dsl::current_obj()  "current_obj()"
+- @ref qutest_dsl::query_curr()   "query_curr()"
+- @ref qutest_dsl::tick()         "tick()"
+- @ref qutest_dsl::expect_pause() "expect_pause()"
+- @ref qutest_dsl::continue_test() "continue_test()"
+- @ref qutest_dsl::init()         "init()"
+- @ref qutest_dsl::dispatch()     "dispatch()"
+- @ref qutest_dsl::post()         "post()"
+- @ref qutest_dsl::publish()      "publish()"
+- @ref qutest_dsl::probe()        "probe()"
+- @ref qutest_dsl::peek()         "peek()"
+- @ref qutest_dsl::poke()         "poke()"
+- @ref qutest_dsl::fill()         "fill()"
+- @ref qutest_dsl::pack()         "pack()"
+- @ref qutest_dsl::test_file()    "test_file()"
+- @ref qutest_dsl::test_dir()     "test_dir()"
+- @ref qutest_dsl::last_rec()     "last_rec()"
 
 
 @section qutest_qspy Categories of QSPY Output

doxygen/snippets/command.py

@@ -3,3 +3,4 @@
 command(0, 78) # <===
 expect("...")
 ...
+expect("@timestamp Trg-Done QS_RX_COMMAND")

qutest/qutest_dsl.py

@@ -28,7 +28,6 @@
 #
 # @file
 # @brief QUTest Python scripting support (documentation)
-# @ingroup qutest
 
 ## @brief current version of the Python QUTest interface
 VERSION = 712
@@ -49,11 +48,11 @@
 # include("../my_include/test_include.pyi") # relative directory
 # @endcode
 #
-# __Example__@n
-# file to be included:@n
+# __Example__<br>
+# file to be included:<br>
 # @include inc_file.py
 #
-# test script calling `include()`:@n
+# test script calling `include()`:<br>
 # @include inc_test.py
 #
 def include(fname):
@@ -177,7 +176,7 @@ def ensure(bool_expr):
 # A given filter-group or an individual filter is set when it is positive, and
 # cleared with it is preceded with the minus (`-`) sign.
 #
-# @n
+# <br>
 # The filter list can contain the following:
 # @code{py}
 # GRP_ALL # all Record-Types
@@ -215,8 +214,8 @@ def glb_filter(*args):
 #
 # @param[in] args  list of QS-ID groups or individual QS-IDs to set or clear.
 # A given filter-group or an individual filter is set when it is positive, and
-# cleared with it is preceded with the minus (`-`) sign.
-# @n
+# cleared with it is preceded with the minus (`-`) sign.<br>
+#
 # This parameter can take one of the following values:
 # @code{py}
 # IDS_ALL # all QS-IDs
@@ -241,8 +240,8 @@ def loc_filter(*args):
 # Unlike loc_filter(), this facility changes **only** the QS-ID (AO's priority) of the given AO in the Target.
 # All other Local Filters will be left unchanged.
 #
-# @param[in] obj_id  active object to set/clear the local filter for in the Target
-# @n
+# @param[in] obj_id  active object to set/clear the local filter for in the Target<br>
+#
 # This parameter can be either a string (name of the AO) or the AO's priority.
 # Also, it can be either positive (to set) or negative (to clear) the QS local filter.
 #
@@ -259,8 +258,8 @@ def ao_filter(obj_id):
 # @description
 # This command sets the "current object" in the Target.
 #
-# @param[in] obj_kind  Kind of object to set
-# @n
+# @param[in] obj_kind  Kind of object to set<br>
+#
 # This parameter can take one of the following values:
 # @code{py}
 # OBJ_SM # State Machine object
@@ -290,13 +289,13 @@ def current_obj(obj_kind, obj_id):
 # This command queries the current object in the Target.
 #
 # @param[in] obj_kind  Kind of object to query
-# @n
+#
 # This parameter can take one of the following values:
 # @code{py}
-# OBJ_SM # State Machine object@n
-# OBJ_AO # Active Object object@n
-# OBJ_MP # Memory Pool object@n
-# OBJ_EQ # Event Queue object@n
+# OBJ_SM # State Machine object
+# OBJ_AO # Active Object object
+# OBJ_MP # Memory Pool object
+# OBJ_EQ # Event Queue object
 # OBJ_TE # Time Event object
 # @endcode
 #
@@ -324,11 +323,11 @@ def query_curr(obj_kind):
 ## @brief trigger system clock tick in the Target
 #
 # @description
-# This command triggers the following actions in the Target:@n
+# This command triggers the following actions in the Target:<br>
 # 1. If the @ref current_obj() "current TE object" is defined and
 #    the TE is armed, the TE is disarmed (if one-shot) and then
-#     posted to the recipient AO.@n
-# 2. The linked-list of all armed Time Events is updated.@n
+#     posted to the recipient AO.
+# 2. The linked-list of all armed Time Events is updated.
 #
 # @param[in] tick_rate  the tick rate (0..QF_MAX_TICK_RATE)
 #
@@ -394,7 +393,7 @@ def continue_test():
 # This command causes execution of the callback QS_onCommand() inside the
 # the Target system.
 #
-# @param[in] cmdId  the command-id first argument to QS_onCommand()@n
+# @param[in] cmdId  the command-id first argument to QS_onCommand()<br>
 #            NOTE: this could be either the raw number or a name
 #            that is delivered by QS_USR_DICTIONARY() from the Target
 # @param[in] param1 the "param1" argument to QS_onCommand() (optional)