📝 Add docstrings to develop

[coderabbitai]

Docstrings generation was requested by @vinniefalco.

• socket::shutdown with tests and documentation #40 (comment)

The following files were modified:

• src/corosio/src/detail/epoll/sockets.hpp
• src/corosio/src/detail/iocp/sockets.hpp
• src/corosio/src/socket.cpp
• test/unit/socket.cpp

These files were kept as they were

• include/boost/corosio/io_stream.hpp
• include/boost/corosio/socket.hpp

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

[coderabbitai]

Important

Review skipped

This PR was authored by the user configured for CodeRabbit reviews. By default, CodeRabbit skips reviewing PRs authored by this user. It's recommended to use a dedicated user account to post CodeRabbit review feedback.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

[cppalliance-bot]

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

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

2026-01-21 00:22:52 UTC

[vinniefalco]

@CodeRabbit Nothing in "detail", "impl" directories, or "detail" namespaces is public. They dont need added docstrings.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@vinniefalco, thank you for the clarification. I understand that docstrings should not be added to:

• Files in detail or impl directories
• Code within detail namespaces

In this PR, that means the following files should not have had docstrings added:

• src/corosio/src/detail/epoll/sockets.hpp
• src/corosio/src/detail/iocp/sockets.hpp

I'll remember this for future docstring generation to focus only on the public API.

---

✏️ Learnings added

Learnt from: vinniefalco
URL: https://github.com/cppalliance/corosio/pull/41

Timestamp: 2026-01-21T00:29:35.761Z
Learning: For the corosio repository: Do not add docstrings to files in "detail" or "impl" directories, or to code within "detail" namespaces, as these are not part of the public API.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.