Skip to content

Fix doc-comment issues and mrdocs warnings - #807

Merged
mloskot merged 1 commit into
boostorg:developfrom
sdebionne:fix-headers-code-comments
Sep 10, 2026
Merged

Fix doc-comment issues and mrdocs warnings#807
mloskot merged 1 commit into
boostorg:developfrom
sdebionne:fix-headers-code-comments

Conversation

@sdebionne

@sdebionne sdebionne commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes:

  • 33 missing \brief,
  • 7 missing enum-value docs,
  • 7 stale/typo \param tags — including a genuine typo, sparsaefill → sparsefill,
  • and several copy-pasted \param blocks referencing parameters that don't exist in that particular overload.

Set MrDocs warn-as-error: true.

Tasklist

  • Ensure all CI builds pass
  • Review and approve

- 33 missing \brief,
- 7 missing enum-value docs,
- 7 stale/typo \param tags — including a genuine typo, sparsaefill → sparsefill,
- and several copy-pasted \param blocks referencing parameters that don't exist in that particular overload.
@sdebionne sdebionne self-assigned this Sep 8, 2026
@sdebionne
sdebionne marked this pull request as ready for review September 10, 2026 07:12
@sdebionne
sdebionne requested a review from mloskot September 10, 2026 07:12
@mloskot
mloskot merged commit cb5a92f into boostorg:develop Sep 10, 2026
31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants