---
id: TASK-9.2
title: Update docs to match new Rustdoc style rules
status: Done
assignee:
  - codex
created_date: '2026-02-24 18:23'
updated_date: '2026-02-24 18:30'
labels: []
dependencies: []
parent_task_id: TASK-9
---

## Description

<!-- SECTION:DESCRIPTION:BEGIN -->
Apply the agreed Rustdoc conventions across the codebase: move attributes to follow doc blocks and convert function docs to the doxygen-style multiline format for consistency.
<!-- SECTION:DESCRIPTION:END -->

## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 All Rustdoc comments for functions use the doxygen-style multiline format defined in the guide.
- [x] #2 Attributes associated with documented items are placed after the corresponding doc blocks, per the guide.
- [x] #3 No public API docs are left in the legacy style after the changes.
<!-- AC:END -->

## Implementation Plan

<!-- SECTION:PLAN:BEGIN -->
1. Inventory Rustdoc function comments and attribute placement across `src/` (public + private), focusing on modules with legacy `///` function docs.
2. Convert function docs to the doxygen-style multiline format, ensuring required sections are present where applicable.
3. Move any attributes (e.g., `#[must_use]`) to appear after the doc block and before the item.
4. Re-scan to confirm no public API docs remain in the legacy format.
<!-- SECTION:PLAN:END -->

## Implementation Notes

<!-- SECTION:NOTES:BEGIN -->
Converted function Rustdoc comments in `src/` to the doxygen-style multiline format, moved attributes to follow doc blocks, and linked the Rustdoc style guide in `AGENTS.md`. Tests not run (documentation-only).
<!-- SECTION:NOTES:END -->

## Final Summary

<!-- SECTION:FINAL_SUMMARY:BEGIN -->
Unified function documentation style across `src/` by converting function docs to doxygen-style multiline comments and ensuring attributes (e.g., `#[must_use]`) appear after doc blocks. Added the Rustdoc style guide link to `AGENTS.md` for discoverability. Tests not run (documentation-only).
<!-- SECTION:FINAL_SUMMARY:END -->
