docs: correct example code, javadoc, and cross-references#286
Conversation
|
An automated preview of the documentation is available at https://286.corosio.prtest3.cppalliance.org/index.html If more commits are pushed to the pull request, the docs will rebuild at the same URL. 2026-06-21 01:28:52 UTC |
|
GCOVR code coverage report https://286.corosio.prtest3.cppalliance.org/gcovr/index.html Build time: 2026-06-21 01:35:41 UTC |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #286 +/- ##
========================================
Coverage 77.90% 77.90%
========================================
Files 96 96
Lines 7160 7160
Branches 1751 1751
========================================
Hits 5578 5578
Misses 1078 1078
Partials 504 504
Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
sgerbino
force-pushed
the
pr/doc-pass
branch
2 times, most recently
from
839dae8 to
1b06a2e
Compare
Align the documentation with the actual API: - Use capy:: for composed read/write/run and for the buffer-sequence concepts (ConstBufferSequence/MutableBufferSequence) - Use std:: error handling throughout (std::error_code, std::system_error, std::errc, std::system_category); io_result has no value(), so examples bind [ec, ...] and throw std::system_error on failure - Use corosio:: address types and the error_code parse API in place of Boost.URL - Populate tcp_server workers with set_workers(); bind and listen the acceptor as separate steps or via the convenience constructor - Fix the TLS examples: flat tls_* enums, pointer-form stream construction with a tls_context, and a separate tls_stream& path - Correct factual details: socket_option::no_delay, the io_context concurrency-hint clamp, signal_set remove()/clear() signatures, the local_endpoint path limit, and the Boost dependency list Apply the same corrections to the header javadoc @code examples in resolver, tls_context, and io_stream. Qualify same-directory page cross-references so Antora resolves them.
2 participants
Align the documentation with the actual API:
Apply the same corrections to the header javadoc @code examples in resolver, tls_context, and io_stream.
Qualify same-directory page cross-references so Antora resolves them.