Repository navigation
Documentation using Sphinx - #35
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
What is public gets a comment Doxygen can see, with \param and \return, instead of '//' blocks and nothing at all. What is there for the library's own use, like the constructors that take an implementation, goes between \cond and \endcond, so a symbol without a comment can be an error. The comments name errors as errors::, which holds in both API styles, and no longer point to the README for what is about to move out of it. Only comments change, apart from error_code now being an alias rather than a using-declaration, which is what Doxygen sees as a type of its own. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
… Doxygen Laid out like the documentation of c-ares-async: a programmer's guide written by hand and an API reference made from the comments in the public headers, as one site in the Read the Docs theme. 'cmake --build build --target docs' makes it, with warnings as errors in both tools, so a public symbol without a comment and a reference that goes nowhere fail the target. The code of the guide is in docs/snippets.cpp and docs/examples/, which every tree compiles with ANYHTTP_BUILD_DOCS, in both API styles. test/test_docs.cpp runs it over all three protocols as well, as this guide is about what operations do, which compiling it does not show. What the README had about semantics moved to pages of their own, and the README is an overview now. The Markdown files that document something became pages too. The ones that are records of how something was done or measured stay Markdown, and the site links to them. A site has one deployment, so the Documentation job only makes the pages, and the Coverage job publishes them, at the root, with its report next to them. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
No description provided.