RTEMS | bsps/erc32: Add missing Doxygen headers (!1470)

[Sweta Patel (@SwetaPatel101)]

Sweta Patel created a merge request: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/1470

Project:Branches: SwetaPatel101/rtems:erc32-doxygen-headers to rtems/rtos/rtems:main
Author:   Sweta Patel



## Summary

The clock driver and polled console files in the erc32 BSP had no @file tag, so Doxygen did not include them in the generated documentation.

This adds @file, @ingroup and @brief headers to both files, following the convention used by the other files.

The existing descriptive comment in ckinit.c is still there inside the new block. No functional change is done.

Files changed:

- bsps/sparc/erc32/clock/ckinit.c
- bsps/sparc/erc32/console/debugputs.c

## AI Details

### Prompt used

Prompts were part of an extended conversation rather than a single prompt.

Representative prompts for this change, close to what I asked:

- "Which files in bsps/sparc/erc32 are missing Doxygen @file headers?"
- "Write a Doxygen @file/@ingroup/@brief header block for bsps/sparc/erc32/clock/ckinit.c following the convention used by the other files in this BSP."
- "Check my diff against the review comments on MR !896."

Context: this is my first contribution to RTEMS. I read the Quick Start and Contributing documentation myself and chose a small documentation change to learn the workflow. I wrote the final headers myself against the existing files in the BSP, confirmed @ingroup RTEMSBSPsSPARCERC32 matches the eight files already using it, checked git diff --check reports no whitespace errors, and confirmed sparc/erc32 still builds with no new warnings.

### AI model used

Claude (Anthropic), model Claude Sonnet 5 from the Claude web.

### How AI was used for the contribution

- [x] Formatting
- [ ] Test creation.
- [x] Code comments.
- [ ] The entire contribution was generated using AI
- [ ] AI code completion such as Copilot in VSCode.

If others were used please add below

### Access

I used Claude through my own Anthropic account, which is a licensed access. Anthropic's Consumer Terms assign to the user all of Anthropic's right, title and interest, if any, in the outputs, so Anthropic does not claim copyright over them. Nothing in the terms restricts contributing that output to an open source project under the project's licence.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/1470
You're receiving this email because of your account on gitlab.rtems.org. Unsubscribe from this thread: https://gitlab.rtems.org/-/sent_notifications/5-5dpmhgqq084tr3xa4s454em8l-1d/unsubscribe | Manage all notifications: https://gitlab.rtems.org/-/profile/notifications | Help: https://gitlab.rtems.org/help


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260904/377b04e2/attachment.htm>