feat(generators): document function parameters and template parameters right after the description - #1320
Open
gennaroprota wants to merge 1 commit into
Conversation
…s right after the description We documented a symbol's template parameters and function parameters near the end of the symbol's page: on a class page, after the members and the non-member functions; on a function page, after the exceptions and the return value. Member descriptions often refer to the template parameters, so that order was at best inconvenient for class templates. It also seemed unnatural for functions. Both sections now appear right after the description on every kind of page, as they do on cppreference.com. Fixes cppalliance#1231.
Contributor
✨ Highlights
🧾 Changes by Scope
🔝 Top Files
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1320 +/- ##
========================================
Coverage 83.12% 83.12%
========================================
Files 35 35
Lines 3662 3662
Branches 844 844
========================================
Hits 3044 3044
Misses 410 410
Partials 208 208
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
An automated preview of the documentation is available at https://1320.mrdocs.prtest2.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-09-23 14:20:29 UTC |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We documented a symbol's template parameters and function parameters near the end of the symbol's page: on a class page, after the members and the non-member functions; on a function page, after the exceptions and the return value. Member descriptions often refer to the template parameters, so that order was at best inconvenient for class templates. It also seemed unnatural for functions.
Both sections now appear right after the description on every kind of page, as they do on cppreference.com.
Changes
Testing
The golden tests pin the section order on every page that documents parameters or template parameters, in both AsciiDoc and HTML. Each regenerated file, including the two outside the golden suite, was checked to contain exactly the lines it had before, in the new order.
Documentation
The documentation pages that show rendered examples take them from the golden fixtures, so they follow the new order without changes. The two committed pages rendered outside the golden suite are regenerated: the landing page (docs/website/index.html, re-rendered with render.js) and the ghostwriter example's output (examples/extensions/ghostwriter/reference.adoc, which the Corpus Transforms page includes). No prose describes the section order.
Fixes #1231.