Features

🔍 Features

ID	Title	SI	Errors
FE_SCL_C	C Language Support		FAULT_SCL_C_1; FAULT_SCL_C_2
FE_SCL_CLI_ANALYZE	Analyze marked content via CLI interface		FAULT_SCL_CLI_ANALYZE_1; FAULT_SCL_CLI_ANALYZE_2; FAULT_SCL_CLI_ANALYZE_3
FE_SCL_CLI_DISCOVER	Discover the filepaths a specified root directory via CLI interface		FAULT_SCL_CLI_DISCOVER_1; FAULT_SCL_CLI_DISCOVER_2
FE_SCL_CLI_WRITE	Export marked content to other formats via CLI interface		FAULT_SCL_CLI_WRITE_1; FAULT_SCL_CLI_WRITE_2; FAULT_SCL_CLI_WRITE_3
FE_SCL_CMT	Customized comment styles		FAULT_SCL_CMT
FE_SCL_CPP	C++ Language Support		FAULT_SCL_CPP_1; FAULT_SCL_CPP_2
FE_SCL_DEF	Define new traceability objects in source code		FAULT_SCL_1; FAULT_SCL_2
FE_SCL_LNK	Link code to existing need items		FAULT_SCL_LNK_1; FAULT_SCL_LNK_2
FE_SCL_PY	Python Language Support		FAULT_SCL_PY_1; FAULT_SCL_PY_2
FE_SCL_RST_EXTRACTION	Extract blocks of reStructuredText embedded within comments		FAULT_SCL_RST_EXTRACTION_1; FAULT_SCL_RST_EXTRACTION_2; FAULT_SCL_RST_EXTRACTION_3

Feature: Define new traceability objects in source code FE_SCL_DEF

style: green_bar child needs: FAULT_SCL_1, FAULT_SCL_2 tools: TOOL_SCL

Create new Sphinx-Needs directly from a single comment line in your source code. Fault: Traceability objects are not detected in supported languages FAULT_SCL_1 parent needs: FE_SCL_DEF Fault: Sphinx-codelinks halucinates traceability objects FAULT_SCL_2 parent needs: FE_SCL_DEF

Feature: C Language Support FE_SCL_C

style: green_bar child needs: FAULT_SCL_C_1, FAULT_SCL_C_2 tools: TOOL_SCL

Support for defining traceability objects in C source code. Fault: Traceability objects are not detected in C language FAULT_SCL_C_1 parent needs: FE_SCL_C Fault: Sphinx-codelinks halucinates traceability objects in C FAULT_SCL_C_2 parent needs: FE_SCL_C

Feature: C++ Language Support FE_SCL_CPP

style: green_bar child needs: FAULT_SCL_CPP_1, FAULT_SCL_CPP_2 tools: TOOL_SCL

Support for defining traceability objects in C++ source code. Fault: Traceability objects are not detected in C++ language FAULT_SCL_CPP_1 parent needs: FE_SCL_CPP Fault: Sphinx-codelinks halucinates traceability objects in C++ FAULT_SCL_CPP_2 parent needs: FE_SCL_CPP

Feature: Python Language Support FE_SCL_PY

style: green_bar child needs: FAULT_SCL_PY_1, FAULT_SCL_PY_2 tools: TOOL_SCL

Support for defining traceability objects in Python source code. Fault: Traceability objects are not detected in Python language FAULT_SCL_PY_1 parent needs: FE_SCL_PY Fault: Sphinx-codelinks halucinates traceability objects in Python FAULT_SCL_PY_2 parent needs: FE_SCL_PY

Feature: Customized comment styles FE_SCL_CMT

style: green_bar child needs: FAULT_SCL_CMT tools: TOOL_SCL

Support for different customized comment styles in source code. The comment structure can be defined in the configuration file. Fault: Customized comment styles are not detected in supported languages FAULT_SCL_CMT parent needs: FE_SCL_CMT

Feature: Link code to existing need items FE_SCL_LNK

style: green_bar child needs: FAULT_SCL_LNK_1, FAULT_SCL_LNK_2 tools: TOOL_SCL

Link code to existing need items without creating new ones, perfect for tracing implementations to requirements. Fault: Linking code to existing need items fails FAULT_SCL_LNK_1 parent needs: FE_SCL_LNK Fault: Sphinx-codelinks links code to wrong need items FAULT_SCL_LNK_2 parent needs: FE_SCL_LNK

Feature: Extract blocks of reStructuredText embedded within comments FE_SCL_RST_EXTRACTION

style: green_bar child needs: FAULT_SCL_RST_EXTRACTION_1, FAULT_SCL_RST_EXTRACTION_2, FAULT_SCL_RST_EXTRACTION_3 tools: TOOL_SCL

Extract blocks of reStructuredText embedded within comments, allowing you to include rich documentation with associated metadata right next to your code. Fault: Extracting reStructuredText from comments fails FAULT_SCL_RST_EXTRACTION_1 parent needs: FE_SCL_RST_EXTRACTION Fault: Sphinx-codelinks extracts wrong reStructuredText blocks FAULT_SCL_RST_EXTRACTION_2 parent needs: FE_SCL_RST_EXTRACTION Fault: Extracted reStructuredText blocks are malformed FAULT_SCL_RST_EXTRACTION_3 parent needs: FE_SCL_RST_EXTRACTION

Feature: Analyze marked content via CLI interface FE_SCL_CLI_ANALYZE

style: green_bar child needs: FAULT_SCL_CLI_ANALYZE_1, FAULT_SCL_CLI_ANALYZE_2, FAULT_SCL_CLI_ANALYZE_3 tools: TOOL_SCL

It shall be possible to analyze marked content via the CLI interface. Fault: CLI integration fails silently FAULT_SCL_CLI_ANALYZE_1 parent needs: FE_SCL_CLI_ANALYZE Fault: Sphinx-codelinks halucinates marked content FAULT_SCL_CLI_ANALYZE_2 parent needs: FE_SCL_CLI_ANALYZE Fault: Sphinx-codelinks misses marked content FAULT_SCL_CLI_ANALYZE_3 parent needs: FE_SCL_CLI_ANALYZE

Feature: Discover the filepaths a specified root directory via CLI interface FE_SCL_CLI_DISCOVER

style: green_bar child needs: FAULT_SCL_CLI_DISCOVER_1, FAULT_SCL_CLI_DISCOVER_2 tools: TOOL_SCL

It shall be possible to specify a root directory for the CLI interface. All files in and below this directory shall be discovered. Fault: Specifying a root directory fails FAULT_SCL_CLI_DISCOVER_1 parent needs: FE_SCL_CLI_DISCOVER Fault: Sphinx-codelinks discovers files outside the specified root directory FAULT_SCL_CLI_DISCOVER_2 parent needs: FE_SCL_CLI_DISCOVER Root directory setting is not respected or ignored

Feature: Export marked content to other formats via CLI interface FE_SCL_CLI_WRITE

style: green_bar child needs: FAULT_SCL_CLI_WRITE_1, FAULT_SCL_CLI_WRITE_2, FAULT_SCL_CLI_WRITE_3 tools: TOOL_SCL

It shall be possible to export marked content to other formats via the CLI interface. Fault: Exporting marked content fails FAULT_SCL_CLI_WRITE_1 parent needs: FE_SCL_CLI_WRITE Fault: Sphinx-codelinks exports wrong content FAULT_SCL_CLI_WRITE_2 parent needs: FE_SCL_CLI_WRITE Fault: Exported content is malformed FAULT_SCL_CLI_WRITE_3 parent needs: FE_SCL_CLI_WRITE