chore/115-manual-review-and-cleanup

hoogv commented

2026-07-25 19:16:55 +00:00

Owner

Description

In this pull-request the code for the DSS hal has been revised a bit by removing the comments. This PR serves as another means to review the code once again.

Why

This PR and contribution improves the quality of the code and introduces another check/moment where the hal is once again reviewed by human eyes.

Closes #115

Type of Change

Chore / maintenance

Impact Assessment

Functional impact: None
Regulatory impact: None (only comments changed)
QMS impact: None
Risk impact: None

Testing

CI pipeline passes (compile, unit tests, integration tests, static analysis)
Manually tested:
No regressions observed in related areas

PR Size

XL (> 300 lines) — must split unless exemption declared

Size justification / exemption (if L or XL):

The size of PR is big due to the amount of comment lines being removed from 10 files. No code was changed.

Exemption

This PR contains removal of comments.
Excluded lines: ALL.
Effective reviewed lines: ALL

Checklist

Commit messages follow type(scope): description convention with Relates to #<issue> footer
PR template filled in completely
No unverified external binaries introduced (see QMS-GITFLOW-001 Binary Security section)
All commits leave the codebase in a compilable, passing-tests state (Commit Integrity Rule)
Reviewer assigned
QMS maintainer approval obtained (required for QMS and device repository changes)

Summary

No code was altered in this pr. Only comments.

## Description  In this pull-request the code for the DSS hal has been revised a bit by removing the comments. This PR serves as another means to review the code once again. ## Why  This PR and contribution improves the quality of the code and introduces another check/moment where the hal is once again reviewed by human eyes. ## Related Issue  Closes #115 ## Type of Change - [x] Chore / maintenance ## Impact Assessment - **Functional impact:** None  - **Regulatory impact:** None (only comments changed)  - **QMS impact:** None  - **Risk impact:** None  ## Testing  - [x] CI pipeline passes (compile, unit tests, integration tests, static analysis) - [x] Manually tested:  - [x] No regressions observed in related areas ## PR Size  - [x] XL (> 300 lines) — must split unless exemption declared **Size justification / exemption (if L or XL):** The size of PR is big due to the amount of comment lines being removed from 10 files. No code was changed. ## Exemption This PR contains removal of comments. Excluded lines: ALL. Effective reviewed lines: ALL ## Checklist - [x] Commit messages follow `type(scope): description` convention with `Relates to #<issue>` footer - [x] PR template filled in completely - [x] No unverified external binaries introduced (see QMS-GITFLOW-001 Binary Security section) - [x] All commits leave the codebase in a compilable, passing-tests state (Commit Integrity Rule) - [x] Reviewer assigned - [x] QMS maintainer approval obtained (required for QMS and device repository changes) ## Summary  No code was altered in this pr. Only comments.

hoogv added 7 commits

2026-07-25 19:16:55 +00:00

chore(dss-adcbuf): clean-up adcbuf comments 94ab5bdf3f

This driver was written on-basis of the TI-hal with claude-code. Claude adds a
lot of comments to the code to keep track of its own changes. Fornutely most of it is churn and does not add to the quality of the driv
er and can be removed. Especially the comments about why loops are bounded, that's because I told him to in regards with MISRA and some
 registers being out-of-scope because not described in RM or the TI hal code.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(dss-cache): trim and remove comments in dss-cache ce88729a15

Trim and remove comments in the header so that the header and function description are less ambiguous to the developer.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(dss-edma): remove comments in the hal_edma module 13290eba40

Remove redundant comments generated by claude in the modules.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(dss-mailbox): clean-up comments in hal_mailbox c97c66e148

Remove redundant comments that would otherwise get out of date or hinders readability.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(hal_dss_hwa): cleanup comments of the hal_dss_hwa module e63c918ce7

Cleanup comments created by claude. As the output is very verbose and does not contribute to being in the code.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(hal_dss_intc): cleanup comments in the hal_dss_intc module ce864c400e

Cleanup comments made by claude code. Which overly document the module.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

chore(hal_dss_rti): cleanup the comments in the hal_dss_rti module

lint / clang-format (pull_request) Successful in 11s

Details

tests / host-tests (pull_request) Successful in 46s

Details

lint / misra (pull_request) Successful in 1m13s

Details

lint / clang-format (push) Successful in 11s

Details

tests / host-tests (push) Successful in 46s

Details

lint / misra (push) Successful in 1m14s

Details

e10e45bc99

The comments in the hal_dss_rti module were generated by claude and are overly verbose on certain parts and also irrelevant.

Relates to #115

Signed-off-by: Victor Hogeweij <hogeweyv@gmail.com>

hoogv added this to the Development project

2026-07-25 19:20:15 +00:00

hoogv self-assigned this

2026-07-25 19:20:16 +00:00

hoogv added this to the Revision V1.0 Launch milestone

2026-07-25 19:20:19 +00:00

hoogv merged commit e10e45bc99 into dev

2026-07-25 19:39:45 +00:00