Repository navigation
docs: link @see targets with @ref and gate bare @see names - #403
Merged
Merged
Conversation
MrDocs treats the text after @see as an ordinary paragraph and does not auto-link names in it, so every "See Also" entry written as `@see delay` rendered as plain text. warn-broken-ref only checks @ref targets, so nothing reported it. Rewrite the 122 bare @see lines in the public headers as `@see @ref name`, moving prose out of the @see lines into the description, and qualify tcp_server inside tcp_server::worker_base, which resolved to the constructor. Drop socket_option's @see of native_socket_option: MrDocs does not extract that namespace, so no link to it can resolve, and the description already names it. Port capy's style guide rule B6 and its doc-lint.mjs check, which flags any @see paragraph, including wrapped lines, holding anything but @ref items. B6 joins the blocking doc_lint gate spec, with selftest fixtures and header-relative locations in the gate report.
|
An automated preview of the documentation is available at https://403.corosio.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-10-21 20:54:51 UTC |
|
GCOVR code coverage report https://403.corosio.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-10-21 21:14:45 UTC |
sgerbino
approved these changes
Oct 21, 2026
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
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.
MrDocs treats the text after @see as an ordinary paragraph and does not auto-link names in it, so every "See Also" entry written as
@see delayrendered as plain text. warn-broken-ref only checks @ref targets, so nothing reported it. Rewrite the 122 bare @see lines in the public headers as@see @ref name, moving prose out of the @see lines into the description, and qualify tcp_server inside tcp_server::worker_base, which resolved to the constructor. Drop socket_option's @see of native_socket_option: MrDocs does not extract that namespace, so no link to it can resolve, and the description already names it.Port capy's style guide rule B6 and its doc-lint.mjs check, which flags any @see paragraph, including wrapped lines, holding anything but @ref items. B6 joins the blocking doc_lint gate spec, with selftest fixtures and header-relative locations in the gate report.