docs: render parameter tables for buffer free functions (#294)#313
Conversation
) Several buffer free functions rendered their parameters as bulleted lists or not at all. MrDocs renders @param as a Name/Description table, and MrDocs added first-class function-object (niebloid) support, so the old workarounds are no longer needed. - buffer_slice: convert the @Par Parameters/@Li list to @param tags; document the deleted rvalue (const&&) overload. - when_any: add @param to the variadic overload. - front, buffer_copy, begin, end, buffer_size, buffer_empty: restore the original anonymous-struct niebloid form (drop the obsolete *_mrdocs_workaround_t type names), mark each with @functionobject, and move @param/@return onto each operator() so MrDocs renders an "Algorithm Function Object" page with a parameter table. ready already used @param and renders correctly; left unchanged.
|
An automated preview of the documentation is available at https://313.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-06-15 16:32:08 UTC |
|
GCOVR code coverage report https://313.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-15 16:47:23 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #313 +/- ##
========================================
Coverage 98.09% 98.09%
========================================
Files 164 164
Lines 8873 8873
========================================
Hits 8704 8704
Misses 169 169
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 4 files with indirect coverage changes Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
2 participants
Several buffer free functions rendered their parameters as bulleted lists or not at all. MrDocs renders @param as a Name/Description table, and MrDocs added first-class function-object (niebloid) support, so the old workarounds are no longer needed.
ready already used @param and renders correctly; left unchanged.
Closes #294