tests/integration/features/source_code_traceability/_language_parsers/c/20_c_backward_and_forward_functions/test.itest

Path:

Lines:

Non-empty lines:

Non-empty lines covered with requirements:

18 / 18 (100.0%)

Functions:

Functions covered by requirements:

0 / 0 (0.0%)

1 - 23 | entire file

"7.2.2. Language-aware parsing of C/C++ code" (REQUIREMENT)
"7.6.3. Language element marker" (REQUIREMENT)
"7.5.1. SDoc markup's forward relations" (REQUIREMENT)

SDOC-SRS-146

7.2.2. Language-aware parsing of C/C++ code

MID:

85a8080f8441485f9111ccda063b34bc

UID:

SDOC-SRS-146

STATUS:

Active

STATEMENT:

StrictDoc shall support parsing the C and C++ source files which includes:

- Recognizing functions and their Doxygen comments.
- Recognizing function declarations and function definitions.

RATIONALE:

C and C++ languages are common languages for embedded and general systems
programming. These languages have to be handled with a dedicated parser because
of these languages' specifics.

RELATIONS (File):

SDOC-SRS-137

7.6.3. Language element marker

MID:

61c23c1b106e4583b2c6d64bf1d296ba

UID:

SDOC-SRS-137

STATUS:

Active

STATEMENT:

StrictDoc shall support relation markers that can be attached to individual
source code elements. StrictDoc shall support an optional scope attribute to
disambiguate the target element where StrictDoc can't infer it solely from the
marker position.

Note: The most basic example of such traceable elements are functions and
classes, but generally supported elements and available scope attributes depend
on the programming language.

RATIONALE:

Source code elements can often be considered as the next level to trace from a
requirement. For example, a low level element is implemented by a function, or a
test case is implemented by a test function.

Sometimes it's also feasible to consider the source code elements as lean
replacement for prose requirement or test-case definitions.

RELATIONS (Parent):

SDOC-SSS-72 Traceability between requirements and source code

RELATIONS (Child):

SDOC-LLR-164 Auto-scoped relation markers in Rust docs

RELATIONS (File):

SDOC-SRS-145

7.5.1. SDoc markup's forward relations

MID:

21637d9bec434d32bb6b97ba5a4e70e6

UID:

SDOC-SRS-145

STATEMENT:

StrictDoc shall support forward linking from SDoc nodes to source files.

RATIONALE:

There are cases when it is not possible to modify source code directly. The
forward linking enables to refer to the files or their parts from SDoc nodes.
Depending on a project structure, the forward linking from requirements to
source files can replace the backward linking from source code back to
requirements, or both approaches can co-exist.

RELATIONS (File):

# @relation(SDOC-SRS-146, SDOC-SRS-137, SDOC-SRS-145, scope=file)

RUN: %strictdoc export %S --output-dir %T | filecheck %s --dump-input=fail

CHECK: Published: Reproducer

RUN: %check_exists --file "%T/html/_source_files/file.c.html"

RUN: %cat %T/html/%THIS_TEST_FOLDER/input.html | filecheck %s --check-prefix CHECK-HTML

CHECK-HTML: <a{{.*}}href="../_source_files/file.c.html#REQ-1#1#55">

CHECK-HTML: <a{{.*}}href="../_source_files/file.c.html#REQ-1#1#55">

CHECK-HTML: <a{{.*}}href="../_source_files/file.c.html#REQ-1#3#10">

CHECK-HTML: <a{{.*}}href="../_source_files/file.c.html#REQ-1#32#33">

CHECK-HTML: <a{{.*}}href="../_source_files/file2.c.html#REQ-1#1#8">

RUN: %cat %T/html/_source_files/file.c.html | filecheck %s --check-prefix CHECK-SOURCE-FILE

CHECK-SOURCE-FILE: 1 - 55 | entire file

CHECK-SOURCE-FILE: 3 - 10 | function foo()

CHECK-SOURCE-FILE: 12 - 16 | range

CHECK-SOURCE-FILE: 22 - 55 | function longFunctionName()

CHECK-SOURCE-FILE: 32 - 33 | line

RUN: %cat %T/html/source_coverage.html | filecheck %s --check-prefix CHECK-SOURCE-COVERAGE

CHECK-SOURCE-COVERAGE: 100.0

1 - 23 | entire file