Features

🔍 Features

ID	Title	SI	Errors
FE_SCL_C	C Language Support		ERR_SCL_C_1; ERR_SCL_C_2
FE_SCL_CLI_ANALYZE	Analyze marked content via CLI interface		ERR_SCL_CLI_ANALYZE_1; ERR_SCL_CLI_ANALYZE_2; ERR_SCL_CLI_ANALYZE_3
FE_SCL_CLI_DISCOVER	Discover the filepaths a specified root directory via CLI interface		ERR_SCL_CLI_DISCOVER_1; ERR_SCL_CLI_DISCOVER_2
FE_SCL_CLI_WRITE	Export marked content to other formats via CLI interface		ERR_SCL_CLI_WRITE_1; ERR_SCL_CLI_WRITE_2; ERR_SCL_CLI_WRITE_3
FE_SCL_CMT	Customized comment styles		ERR_SCL_CMT
FE_SCL_CPP	C++ Language Support		ERR_SCL_CPP_1; ERR_SCL_CPP_2
FE_SCL_DEF	Define new traceability objects in source code		ERR_SCL_1; ERR_SCL_2
FE_SCL_LNK	Link code to existing need items		ERR_SCL_LNK_1; ERR_SCL_LNK_2
FE_SCL_PY	Python Language Support		ERR_SCL_PY_1; ERR_SCL_PY_2
FE_SCL_RST_EXTRACTION	Extract blocks of reStructuredText embedded within comments		ERR_SCL_RST_EXTRACTION_1; ERR_SCL_RST_EXTRACTION_2; ERR_SCL_RST_EXTRACTION_3

Feature: Define new traceability objects in source code FE_SCL_DEF

style: green_bar child needs: ERR_SCL_1, ERR_SCL_2 tools: TOOL_SCL

Create new Sphinx-Needs directly from a single comment line in your source code. Error: Traceability objects are not detected in supported languages ERR_SCL_1 style: red_bar parent needs: FE_SCL_DEF Error: Sphinx-codelinks halucinates traceability objects ERR_SCL_2 style: red_bar parent needs: FE_SCL_DEF

Feature: C Language Support FE_SCL_C

style: green_bar child needs: ERR_SCL_C_1, ERR_SCL_C_2 tools: TOOL_SCL

Support for defining traceability objects in C source code. Error: Traceability objects are not detected in C language ERR_SCL_C_1 style: red_bar parent needs: FE_SCL_C Error: Sphinx-codelinks halucinates traceability objects in C ERR_SCL_C_2 style: red_bar parent needs: FE_SCL_C

Feature: C++ Language Support FE_SCL_CPP

style: green_bar child needs: ERR_SCL_CPP_1, ERR_SCL_CPP_2 tools: TOOL_SCL

Support for defining traceability objects in C++ source code. Error: Traceability objects are not detected in C++ language ERR_SCL_CPP_1 style: red_bar parent needs: FE_SCL_CPP Error: Sphinx-codelinks halucinates traceability objects in C++ ERR_SCL_CPP_2 style: red_bar parent needs: FE_SCL_CPP

Feature: Python Language Support FE_SCL_PY

style: green_bar child needs: ERR_SCL_PY_1, ERR_SCL_PY_2 tools: TOOL_SCL

Support for defining traceability objects in Python source code. Error: Traceability objects are not detected in Python language ERR_SCL_PY_1 style: red_bar parent needs: FE_SCL_PY Error: Sphinx-codelinks halucinates traceability objects in Python ERR_SCL_PY_2 style: red_bar parent needs: FE_SCL_PY

Feature: Customized comment styles FE_SCL_CMT

style: green_bar child needs: ERR_SCL_CMT tools: TOOL_SCL

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

Feature: Link code to existing need items FE_SCL_LNK

style: green_bar child needs: ERR_SCL_LNK_1, ERR_SCL_LNK_2 tools: TOOL_SCL

Link code to existing need items without creating new ones, perfect for tracing implementations to requirements. Error: Linking code to existing need items fails ERR_SCL_LNK_1 style: red_bar parent needs: FE_SCL_LNK Error: Sphinx-codelinks links code to wrong need items ERR_SCL_LNK_2 style: red_bar parent needs: FE_SCL_LNK

Feature: Extract blocks of reStructuredText embedded within comments FE_SCL_RST_EXTRACTION

style: green_bar child needs: ERR_SCL_RST_EXTRACTION_1, ERR_SCL_RST_EXTRACTION_2, ERR_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. Error: Extracting reStructuredText from comments fails ERR_SCL_RST_EXTRACTION_1 style: red_bar parent needs: FE_SCL_RST_EXTRACTION Error: Sphinx-codelinks extracts wrong reStructuredText blocks ERR_SCL_RST_EXTRACTION_2 style: red_bar parent needs: FE_SCL_RST_EXTRACTION Error: Extracted reStructuredText blocks are malformed ERR_SCL_RST_EXTRACTION_3 style: red_bar parent needs: FE_SCL_RST_EXTRACTION

Feature: Analyze marked content via CLI interface FE_SCL_CLI_ANALYZE

style: green_bar child needs: ERR_SCL_CLI_ANALYZE_1, ERR_SCL_CLI_ANALYZE_2, ERR_SCL_CLI_ANALYZE_3 tools: TOOL_SCL

It shall be possible to analyze marked content via the CLI interface. Error: CLI integration fails silently ERR_SCL_CLI_ANALYZE_1 style: red_bar parent needs: FE_SCL_CLI_ANALYZE Error: Sphinx-codelinks halucinates marked content ERR_SCL_CLI_ANALYZE_2 style: red_bar parent needs: FE_SCL_CLI_ANALYZE Error: Sphinx-codelinks misses marked content ERR_SCL_CLI_ANALYZE_3 style: red_bar 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: ERR_SCL_CLI_DISCOVER_1, ERR_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. Error: Specifying a root directory fails ERR_SCL_CLI_DISCOVER_1 style: red_bar parent needs: FE_SCL_CLI_DISCOVER Error: Sphinx-codelinks discovers files outside the specified root directory ERR_SCL_CLI_DISCOVER_2 style: red_bar 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: ERR_SCL_CLI_WRITE_1, ERR_SCL_CLI_WRITE_2, ERR_SCL_CLI_WRITE_3 tools: TOOL_SCL

It shall be possible to export marked content to other formats via the CLI interface. Error: Exporting marked content fails ERR_SCL_CLI_WRITE_1 style: red_bar parent needs: FE_SCL_CLI_WRITE Error: Sphinx-codelinks exports wrong content ERR_SCL_CLI_WRITE_2 style: red_bar parent needs: FE_SCL_CLI_WRITE Error: Exported content is malformed ERR_SCL_CLI_WRITE_3 style: red_bar parent needs: FE_SCL_CLI_WRITE