Sebastian Huber created a merge request: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/1435
Project:Branches: sebhub/rtems:cpukit-doxygen-groups to rtems/rtos/rtems:main Author: Sebastian Huber Assignee: Sebastian Huber ## Summary The generated documentation presents RTEMS as a tree of groups. A reader starts at RTEMSAPI or RTEMSImpl and walks down to a file. 706 of the 2053 files of cpukit in scope reached neither anchor. 291 of them carried no Doxygen block at all. 1279 briefs named a topic instead of the content of the file. Doxygen reported 311 warnings of the kind `Found non-existing group` and then built the page without the group. No build failed, so the defect survived. This series gives every file in scope a block with `@file` and one group which reaches an anchor. It also writes a brief in the style of the tree. A header brief starts with "This header file provides". A source brief starts with "This source file contains". Where a component had no group, a commit defines one. An API header keeps an API group. An implementation group lives in a source file or in an implementation header. | Measure | Before | After | | --- | ---: | ---: | | cpukit warnings outside contrib | 751 | 431 | | `Found non-existing group` in cpukit outside contrib | 311 | 0 | | files with no `@file` block | 291 | 0 | | files with no group which reaches an anchor | 706 | 0 | | briefs not in the style of the tree | 1279 | 0 | No warning of a new kind appears. The whole Doxygen log falls from 2825 to 2502 lines. The 42 commits change 1326 files and touch comments only. No line of code changes. These paths keep what they have. `cpukit/contrib/` and the imported code in `dtc`, `jffs2`, `libmd`, `libcrypt` and `libstdthreads` stay untouched. The generated headers stay untouched, `cpukit/doxygen/appl-config.h` among them. The 23 `confdefs` headers keep their brief. The CAN and CAN FD stack keeps its group name and its briefs. Every commit references #5717. The last commit closes it. ## AI Details <!-- Make sure you have read our statement at https://www.rtems.org/generative-ai/ --> ### Prompt used <!-- Prompt used, please write ‘None’ if no prompt was used --> The work ran as an interactive session in Claude Code. ### AI model used <!-- Please list AI models you have used --> Claude Opus 5, model ID `claude-opus-5`, in Claude Code. Every commit carries the trailer`: Assisted-by: Claude:claude-opus-5 claude-code ### How AI was used for the contribution - (x) Formatting - [ ] Test creation. - (x) Code comments. - (x) The entire contribution was generated using AI - [ ] AI code completion such as Copilot in VSCode. If others were used please add below The assistant wrote every line of the diff. The diff holds Doxygen comments, group definitions and grouping commands. It holds no code. I made every decision which the diff records: - the group of each file - the groups which the tree gains - the file which defines each group - the components which keep their own name and their own briefs - the paths which stay out of scope Each commit message states the problem which its decision solves. The assistant also measured the result. It ran Doxygen before the work and after every step and compared the logs line by line. It ran a check over all 2053 files in scope for the file block, the group and the brief. It audited all 42 commit messages against their diffs and corrected 16 wrong statements, of which 11 were wrong counts. ### Access <!-- Please state that you have not used a product that claims copyright and you have legitimate access. --> I used no product which claims copyright in its output. I have legitimate access to the tool and to the sources. <!-- Default settings, if it is a dropdown it will set after submission --> -- View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/1435 You're receiving this email because of your account on gitlab.rtems.org. Unsubscribe from this thread: https://gitlab.rtems.org/-/sent_notifications/5-f0t23l48289hzwihrdnb6anyi-1d/unsubscribe | Manage all notifications: https://gitlab.rtems.org/-/profile/notifications | Help: https://gitlab.rtems.org/help
_______________________________________________ bugs mailing list [email protected] http://lists.rtems.org/mailman/listinfo/bugs
