Conversation
Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>
Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>
…j2735_c_generator_jinja.py; address circular reference handling in j2735_spec_parser.py Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Pull request overview
This PR is primarily a documentation quality improvement for the J2735 High-Performance Toolkit. It adds directional Doxygen @param[in]/@param[out] annotations across all generated and hand-written C headers, resolves several TODO comments throughout the Python tooling, and adds automatic minimization of stale CI report comments on PRs.
Changes:
- Doxygen annotations: Updated 7 Jinja2 templates and 3 hand-written C headers to use directional
@param[in]/@param[out]annotations; regenerated 15 DE and 4 DF headers accordingly. Added araw_padalignment helper inbitstring_internal_get_one.j2for consistent column alignment. - TODO resolution: Replaced mutually exclusive CLI flags with
argparse'sadd_mutually_exclusive_group(); fixedfilter_c_typeTODO and Pylance type suppression in the Jinja2 environment setup; resolved circular-referencepasswith explicitreturn None; replaced"""TODO"""docstring onBitStringConstraint.ext_bits; clarified 8 "Inspect if still unused" field comments to "Evaluate for generated C Doxygen". - CI improvements: Added GraphQL
minimizeCommentmutation to bothci.ymlandpython.ymlto auto-collapse stale report comments from previous commits.
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
tools/templates/sequence/sequence_*.j2 |
Added @param[in]/@param[out] to all sequence templates; removed Jinja2 explanatory comments from intentional blank-line outputs |
tools/templates/bitstring/bitstring_internal_get_one.j2 |
Added raw_pad alignment variable for consistent column alignment in @param[in] rawXX |
tools/templates/assemble_de_bitstring.j2 |
Removed stale @todo marker |
src/J2735_internal_DE_*.h (15 files) |
All DE headers updated with @param[in]/@param[out] annotations |
src/J2735_internal_DF_*.h (3 files) |
Three DF headers updated with @param[in]/@param[out] annotations |
src/J2735_internal_common.h |
All macros updated with @param[in] directional annotations |
src/J2735_internal_inline.h |
Updated @brief from TODO and added @param[in]/@param[out] annotations |
src/J2735_api.h |
Updated @brief from TODO to descriptive text |
tools/j2735.py |
Replaced independent --summary/--types args with add_mutually_exclusive_group() |
tools/j2735_c_generator_jinja.py |
Removed filter_c_type TODO; used cast() for Jinja2 env.filters type suppression |
tools/j2735_spec_parser.py |
Replaced circular reference pass with return None; clarified 8 TODO comments |
tools/j2735_spec_constraints.py |
Replaced """TODO""" docstring on BitStringConstraint.ext_bits |
.github/workflows/ci.yml |
Added GraphQL minimizeComment loop for stale CI report comments |
.github/workflows/python.yml |
Added GraphQL minimizeComment loop for stale Python CI report comments |
tools/tests/c_generator/test_sequence_size_func.py |
Updated assertions to use @param[in]/@param[out] format |
tools/tests/c_generator/test_sequence_has_extension.py |
Updated exact-output assertions to use @param[in] format |
tools/tests/c_generator/test_assemble_de_bitstring.py |
Refactored single-test into focused per-behavior assertions |
Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>
Signed-off-by: Yogev Neumann <xqgex@users.noreply.github.com>
Contributor
Python CI ReportCommit: Python TestsTest Output✅ All tests passed Coverage: 96%Per-file coverage (10 modules)
Details (906 statements, 40 missed)
Python Static Analysis
mypypylintflake8ruffcodespell |
Contributor
CI ReportCommit: Static Analysis
cppcheckClick to expandclang-tidyClick to expandSanitizers (ASan + UBSan)Test Output✅ No issues detected Valgrind Memory CheckTest Output✅ No memory issues detected |
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.
Pull Request
Description
Add directional Doxygen
@paramannotations to all generated and hand-written C headers, resolve remaining TODO comments across the Python tooling, and auto-minimize stale CI report comments on PRs.@param[in]/@param[out]annotations: Updated 7 Jinja2 templates (sequence_get,sequence_has_extension,sequence_has_field,sequence_size,sequence_internal_off,sequence_internal_width,bitstring_internal_get_one) and 3 hand-written headers (J2735_internal_common.h,J2735_internal_inline.h,J2735_api.h) to use directional parameter annotations. All 15 generated DE headers and 4 generated DF headers now emit@param[in]/@param[out]consistently.j2735.py: Replaced two independent--summary/--typesargparse arguments withadd_mutually_exclusive_group(), so conflicting flags produce a proper error instead of silently ignoring one; removed the associated TODO.j2735_c_generator_jinja.py: Removed stalefilter_c_typeTODO (6 existing doctests already cover the function); suppressed PylancereportUnknownMemberTypeon untypedenv.filterswith an explicitcast(dict[str, Any], ...).j2735_spec_parser.py: Replaced circular-reference TODO+passwith a descriptive comment and explicitreturn None; clarified 8 "Inspect if still unused" field TODOs → "Evaluate for generated C Doxygen" to reflect their actual status.j2735_spec_constraints.py: Replaced placeholderTODOdocstring onBitStringConstraint.ext_bitswith a proper description.@todomarkers fromassemble_de_bitstring.j2; fixed non-extensible wire-format docs that incorrectly included an extension bit in the total count.minimizeCommentmutation to bothci.ymlandpython.ymlto auto-collapse stale report comments from previous commits.Related Issue
N/A
Additional Notes
N/A
Type of Change
Checklist
make pre-pushand all checks passgit commit -s