diff options
Diffstat (limited to 'docs/Reference')
5 files changed, 20 insertions, 18 deletions
diff --git a/docs/Reference/0_BindingTestFunctions.md b/docs/Reference/0_BindingTestFunctions.md index 03905fa..9674d20 100644 --- a/docs/Reference/0_BindingTestFunctions.md +++ b/docs/Reference/0_BindingTestFunctions.md @@ -102,11 +102,11 @@ **_AFT.addEventToMonitor** function. The table has to have this format: - ```lua +```lua eventGrp = {["api/event_name_1"]=1,["api/event_name_2"]=2,["api/event_name_3"]=5} - ``` +``` As you can see, in the table, event names are table keys and the value stored are the number of time that the events have to be received. Check if events has been correctly received in time (timeout in µs). An - event name use the application framework naming scheme: **api/event_name**.
\ No newline at end of file + event name use the application framework naming scheme: **api/event_name**. diff --git a/docs/Reference/1_BindingAssertFunctions.md b/docs/Reference/1_BindingAssertFunctions.md index a007875..5d63d2c 100644 --- a/docs/Reference/1_BindingAssertFunctions.md +++ b/docs/Reference/1_BindingAssertFunctions.md @@ -60,11 +60,11 @@ **_AFT.addEventToMonitor** function. The table has to have this format: - ```lua + ```lua eventGrp = {["api/event_name_1"]=1,["api/event_name_2"]=2,["api/event_name_3"]=5} - ``` + ``` As you can see, in the table, event names are table keys and the value stored are the number of time that the events have to be received. Check if events has been correctly received in time (timeout in µs). - An event name use the application framework naming scheme: **api/event_name**.
\ No newline at end of file + An event name use the application framework naming scheme: **api/event_name**. diff --git a/docs/Reference/2_TestFrameworkFunctions.md b/docs/Reference/2_TestFrameworkFunctions.md index 20184ec..ab81d04 100644 --- a/docs/Reference/2_TestFrameworkFunctions.md +++ b/docs/Reference/2_TestFrameworkFunctions.md @@ -47,13 +47,15 @@ **_AFT.afterEach()** (if set) functions. * **_AFT.setBefore(testName, beforeTestFunction)** + Set a function to be ran at the beginning of the given *testName* function. - ```lua +```lua _AFT.testVerbStatusSuccess('testPingSuccess','hello', 'ping', {}) _AFT.setBefore("testPingSuccess",function() print("~~~~~ Begin testPingSuccess ~~~~~") end) _AFT.setAfter("testPingSuccess",function() print("~~~~~ End testPingSuccess ~~~~~") end) - ``` +``` * **_AFT.setBefore(testName, beforeTestFunction)** - Set a function to be ran at the end of the given *testName* function.
\ No newline at end of file + + Set a function to be ran at the end of the given *testName* function. diff --git a/docs/Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md b/docs/Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md index ed927cd..103adf8 100644 --- a/docs/Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md +++ b/docs/Reference/LuaUnitAssertionFunctions/1_ValueAssertions.md @@ -41,18 +41,18 @@ Example : - ```lua - `s1='toto' +```lua + s1='toto' s2='to'..'to' t1={1,2} t2={1,2} luaunit.assertIs(s1,s1) -- ok luaunit.assertIs(s1,s2) -- ok luaunit.assertIs(t1,t1) -- ok - luaunit.assertIs(t1,t2) -- fail` - ``` + luaunit.assertIs(t1,t2) -- fail +``` * **_AFT.assertNotIs(actual, expected)** Assert that two variables are not identical, in the sense that they do not - refer to the same value. See assertIs() for more details.
\ No newline at end of file + refer to the same value. See assertIs() for more details. diff --git a/docs/Reference/LuaUnitAssertionFunctions/6_TableAssertions.md b/docs/Reference/LuaUnitAssertionFunctions/6_TableAssertions.md index 8d29988..1122bfc 100644 --- a/docs/Reference/LuaUnitAssertionFunctions/6_TableAssertions.md +++ b/docs/Reference/LuaUnitAssertionFunctions/6_TableAssertions.md @@ -7,13 +7,13 @@ This function is practical for example if you want to compare two lists but where items are not in the same order: - ```lua +```lua luaunit.assertItemsEquals( {1,2,3}, {3,2,1} ) -- assertion succeeds - ``` +``` The comparison is not recursive on the items: if any of the items are tables, they are compared using table equality (like as in assertEquals() ), where the key matters. - ```lua +```lua luaunit.assertItemsEquals( {1,{2,3},4}, {4,{3,2,},1} ) -- assertion fails because {2,3} ~= {3,2} - ```
\ No newline at end of file +``` |