summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-04 13:52:40 +0100
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-02-04 14:23:44 +0100
commitd3ae7a9581e1a61821e229738a2289c9b5578ff8 (patch)
tree4b4507aa7544cd05a15f4ced96410545bf36f397
parentcontent: Discard empty C comment blocks (diff)
downloadrtems-central-d3ae7a9581e1a61821e229738a2289c9b5578ff8.tar.bz2
validation: Add action brief descriptions
-rw-r--r--rtemsspec/tests/test_validation.py24
-rw-r--r--rtemsspec/validation.py4
2 files changed, 28 insertions, 0 deletions
diff --git a/rtemsspec/tests/test_validation.py b/rtemsspec/tests/test_validation.py
index 700e1c9e..9ddc90e8 100644
--- a/rtemsspec/tests/test_validation.py
+++ b/rtemsspec/tests/test_validation.py
@@ -858,6 +858,9 @@ T_TEST_CASE_FIXTURE( Directive, &Directive_Fixture )
/* Test case support code */
+/**
+ * @brief Test case action 0 description.
+ */
static void Tc_Action_0( void )
{
/* Test case action 0 code */
@@ -865,6 +868,9 @@ static void Tc_Action_0( void )
/* Test case action 0 check 1 code; step 123 */
}
+/**
+ * @brief Test case action 1 description.
+ */
static void Tc_Action_1( void )
{
/* Test case action 1 code */
@@ -948,6 +954,9 @@ static T_fixture Tc2_Fixture = {
.initial_context = &Tc2_Instance
};
+/**
+ * @brief Test case 2 action 0 description.
+ */
static void Tc2_Action_0( Tc2_Context *ctx )
{
/* Test case 2 action 0 code */
@@ -955,6 +964,9 @@ static void Tc2_Action_0( Tc2_Context *ctx )
/* Test case 2 action 0 check 1 code */
}
+/**
+ * @brief Test case 2 action 1 description.
+ */
static void Tc2_Action_1( Tc2_Context *ctx )
{
/* Test case 2 action 1 code */
@@ -1255,6 +1267,9 @@ T_TEST_CASE_FIXTURE( Rtm, &Rtm_Fixture )
* @{
*/
+/**
+ * @brief Test case 3 action 0 description.
+ */
static void Tc3_Action_0( void )
{
/* Test case 3 action 0 code */
@@ -1354,6 +1369,9 @@ static T_fixture Tc5_Fixture = {
.initial_context = &Tc5_Instance
};
+/**
+ * @brief Test case action 0 description.
+ */
static void Tc5_Action_0( Tc5_Context *ctx )
{
/* Test case action 0 code */
@@ -1361,6 +1379,9 @@ static void Tc5_Action_0( Tc5_Context *ctx )
/* Test case action 0 check 1 code; step 0 */
}
+/**
+ * @brief Test case action 1 description.
+ */
static void Tc5_Action_1( Tc5_Context *ctx )
{
/* Test case action 1 code */
@@ -1416,6 +1437,9 @@ void Tc6_Run( void )
* @{
*/
+/**
+ * @brief Action.
+ */
static void Tc7_Action_0( void )
{
/* 0 */
diff --git a/rtemsspec/validation.py b/rtemsspec/validation.py
index 64e08f54..cbf347e8 100644
--- a/rtemsspec/validation.py
+++ b/rtemsspec/validation.py
@@ -200,6 +200,10 @@ class _TestItem:
params = [f"{self.context} *ctx"]
actions.gap = False
actions.call_function(None, method, args)
+ with content.doxygen_block():
+ content.add_brief_description(
+ self.substitute_text(action["action-brief"]))
+ content.gap = False
with content.function("static void", method, params):
content.add(self.substitute_code(action["action-code"]))
for check in action["checks"]: