Repository navigation
docs: add a reference overview that groups the API by purpose - #484
Conversation
The generated index lists symbols by entity kind only. The new Reference page groups every public symbol into twelve sections, each linking its names through cpp: and the manual pages that teach them. The nav entry now opens this page, with one child per section and an "Index by Kind" child for the generated index. Refs cppalliance#408.
The glossary See Also lists both the grouped overview and the generated index. STYLE_GUIDE E3 records that the overview must list every indexed symbol once and be updated with API changes. Refs cppalliance#408.
Say when strands abandon coroutines, that read and write stop on an error, which frame allocator run_async uses by default, and that the generated index also lists namespaces and operators. E3 now says each symbol is listed once in a table, since intros mention some again. Refs cppalliance#408.
Capy's primitives resume their waiters with a canceled error when destroyed; only execution contexts and strands abandon them. Also say what safe_resume restores, that it resumes a continuation's handle, and that this_coro::environment reads all three values. Refs cppalliance#408.
|
An automated preview of the documentation is available at https://484.capy.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-11-10 22:35:27 UTC |
|
GCOVR code coverage report https://484.capy.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-11-10 22:45:38 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #484 +/- ##
===========================================
+ Coverage 98.45% 98.46% +0.01%
===========================================
Files 135 135
Lines 7250 7250
===========================================
+ Hits 7138 7139 +1
+ Misses 112 111 -1
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
The Methods of API Description intro now links the reference overview, and the buffer-inspection page names the generated index by its new nav label. The overview's chain ownership section now says that when_all, when_any, run and test::run_blocking abandon their caller when a coroutine they started is abandoned.
…overview await_context also carries the segment owner, which this_coro reads only through environment. test::run_blocking does not abandon its caller; it throws error::canceled, so drop it from the upward-abandonment list.
Closes #408. Part of #416.
The generated MrDocs index lists the API by entity kind only. This adds a hand-written Reference page that groups it by purpose, using only what MrDocs already produces: its tagfile and the
cpp:macro. The generated index is unchanged.Changes
doc/modules/ROOT/pages/reference-overview.adoc(new): twelve sections:Each section has a short intro that links the manual pages teaching it, and a
Kind | Namestable. The tables list every symbol on the generatedboost::capy,testandthis_coroindex pages once (93 names), except namespaces and operators, ascpp:links.nav.adoc: "Reference" now opens the overview, with one child per section and an "Index by Kind" child for the generated index.glossary.adoc: the See Also section links both pages.A.specification-methods/A.intro.adoc: its Reference link now points at the overview.7.testing/7e.buffer-inspection.adoc: its link to the generated index now uses the index's new name, "Index by Kind".STYLE_GUIDE.mdE3: records the page, and that an API change must update it in the same pull request.