| name | uni20-doxygen-audit |
| description | Audit and normalize Uni20 Doxygen comments to AGENTS.md policy with minimal, scoped edits. |
Uni20 Doxygen Audit
Overview
Use this skill to apply the Doxygen policy in AGENTS.md section 8.
Keep edits scoped to requested files or changed files unless a full-tree audit is explicitly requested.
Workflow
- Read
AGENTS.md Doxygen policy before editing.
- Determine audit scope (
git diff files by default).
- Identify comment-shape and tag-order violations.
- Patch only documentation issues (avoid unrelated code churn).
- Re-scan scope for remaining violations and summarize.
Audit Scope Helpers
Changed C++ headers/sources:
git diff --name-only -- '*.hpp' '*.h' '*.cpp' '*.cc' '*.cxx'
Find Doxygen blocks quickly:
rg -n "^\s*///|^\s*/\*\*|\\\brief|\\\param|\\\tparam|\\\return|\\\ingroup" src tests bindings
Policy Checklist
- Prefer
/// for ordinary declarations; reserve /** ... */ for file/module overviews.
- New or substantially edited public API Doxygen blocks should start with
\brief.
- Include
\param, \tparam, and \return when they clarify semantics; avoid tautological tags.
- Do not emit
\return on non-callable declarations.
- Keep tag order consistent with
AGENTS.md when several tags are present.
- Avoid placeholder comments and documentation-only churn outside the requested scope.
- Use
\ingroup sparingly; do not repeat it mechanically on members or nested declarations.
- Preserve useful implementation comments (
//, /* ... */) as non-Doxygen comments.
Output Expectations
- Summarize audited files and key fixes.
- Call out any ambiguous declarations requiring manual semantic clarification.
- If full compliance is not completed, list concrete remaining items by file.
