Expose all platform backends in MrDocs documentation build (#171)

[mvandeberg]

Closes #171

Summary by CodeRabbit

Release Notes

• Chores
  • Added MRDOCS build mode support to enable unified documentation generation across all platforms.
  • Improved platform detection logic with conditional compilation guards for backend-specific components.
  • Existing functionality and behavior remain unchanged for standard builds.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e759c2 and 19d2eea.

📒 Files selected for processing (7)

• include/boost/corosio/detail/platform.hpp
• include/boost/corosio/native/native_io_context.hpp
• include/boost/corosio/native/native_resolver.hpp
• include/boost/corosio/native/native_signal_set.hpp
• include/boost/corosio/native/native_tcp_acceptor.hpp
• include/boost/corosio/native/native_tcp_socket.hpp
• include/boost/corosio/tcp_socket.hpp

---

📝 Walkthrough

Walkthrough

Introduces a MRDOCS build mode that conditionally enables all platform-specific feature macros (IOCP, EPOLL, KQUEUE, SELECT, POSIX) unconditionally, while guarding out platform-specific includes to enable documentation generation without backend compilation dependencies.

Changes

Cohort / File(s)	Summary
Platform Detection Setup include/boost/corosio/detail/platform.hpp	Adds MRDOCS branch defining all platform feature macros to 1 unconditionally; preserves per-OS feature detection for non-MRDOCS builds.
Backend Include Guards include/boost/corosio/native/native_io_context.hpp, native_resolver.hpp, native_signal_set.hpp, native_tcp_acceptor.hpp, native_tcp_socket.hpp	Wraps platform-specific backend includes (epoll, select, kqueue, iocp, resolver, signal services) with #ifndef BOOST_COROSIO_MRDOCS guards to exclude compilation under MRDOCS.
Public API Adjustment include/boost/corosio/tcp_socket.hpp	Conditionalizes native_handle_type and is_open() behavior: IOCP path only applies when MRDOCS is not defined; otherwise uses non-IOCP fallback (int type and >= 0 check).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

• MrDocs reference omits platform-specific backends #171: The MRDOCS branch and include guards directly address the omission of MrDocs support by enabling documentation generation with platform-agnostic stubs.

Possibly related PRs

• Removes platform dependent macro pollution #88: Modifies the same platform feature-detection macros and include patterns; this PR builds upon those changes with MRDOCS-specific conditional logic.

Suggested reviewers

• sgerbino

Poem

🐰 A docs-friendly stance, with stubs all in place,
Platform macros united in one MRDOCS space,
Backend guards raised so includes won't compile,
Making MrDocs happy with each guarded file,
Now docs can shine bright without backend's plight! ✨

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main objective of the changeset: enabling visibility of all platform backends (IOCP, EPOLL, KQUEUE, SELECT, POSIX) in MrDocs documentation builds through conditional compilation guards.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.11%. Comparing base (6e759c2) to head (19d2eea).
⚠️ Report is 3 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #176      +/-   ##
===========================================
+ Coverage    71.90%   76.11%   +4.21%     
===========================================
  Files           88       94       +6     
  Lines         9065    10385    +1320     
  Branches      2371     2371              
===========================================
+ Hits          6518     7905    +1387     
- Misses        1560     1764     +204     
+ Partials       987      716     -271     

Flag	Coverage Δ
linux	83.18% <ø> (?)
windows	69.10% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
include/boost/corosio/native/native_io_context.hpp	92.50% <ø> (ø)
include/boost/corosio/native/native_resolver.hpp	92.85% <ø> (ø)
include/boost/corosio/native/native_signal_set.hpp	100.00% <ø> (ø)
...clude/boost/corosio/native/native_tcp_acceptor.hpp	90.90% <ø> (ø)
include/boost/corosio/native/native_tcp_socket.hpp	90.41% <ø> (ø)
include/boost/corosio/tcp_socket.hpp	88.88% <ø> (ø)

... and 19 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6e759c2...19d2eea. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[cppalliance-bot]

An automated preview of the documentation is available at https://176.corosio.prtest3.cppalliance.org/index.html

If more commits are pushed to the pull request, the docs will rebuild at the same URL.

2026-02-25 23:30:51 UTC

[cppalliance-bot]

GCOVR code coverage report https://176.corosio.prtest3.cppalliance.org/gcovr/index.html
LCOV code coverage report https://176.corosio.prtest3.cppalliance.org/genhtml/index.html
Coverage Diff Report https://176.corosio.prtest3.cppalliance.org/diff-report/index.html

Build time: 2026-02-25 23:34:35 UTC