Repository navigation
Refactor documentation and code annotations to standardize '@need:' f… - #33
Merged
Merged
Conversation
…ormat and improve clarity
PhilipPartsch
approved these changes
Oct 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request standardizes and clarifies the way code annotations for requirements ("needs") are written and referenced throughout the codebase and documentation. It also updates some documentation icons and cleans up configuration and JSON files for better maintainability and clarity.
The most important changes are:
Standardization of Code Annotations:
@to annotate needs (e.g.,// @Test ...) to use the explicit@need:prefix for clearer parsing and consistency across all C++ source and test files (src/main.cpp,src/sample1.cpp,src/sample1_unittest.cpp,src/sample2.cpp). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]Documentation and Configuration Updates:
@need:annotation style, including in how-to guides and configuration files (docs/how-to-guides/testing/index.rst,docs/how-to-guides/trace-code/index.rst,docs/ubproject.toml). [1] [2] [3] [4] [5]ubproject.tomlto match the new annotation style by settingstart_sequence = "@need:"for code analysis.Documentation Visual Improvements:
:octicon:bookReference,:octicon:workflowDraw.io Integration). [1] [2] [3] [4] [5]Configuration and JSON Cleanup:
docs/external/needs_external.jsonby removing unused or empty fields from need entries, making the file cleaner and easier to maintain. [1] [2] [3] [4] [5]ubproject.tomlfor better clarity.Minor Project Structure Adjustments:
[project] srcdirto a new[source] dirsection inubproject.tomlfor improved structure.These changes collectively improve the consistency, clarity, and maintainability of both the codebase and its documentation.