summaryrefslogtreecommitdiffstatshomepage
path: root/include/winapi/pipe.hpp
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2022-03-10 12:39:04 +0500
committerEgor Tensin <Egor.Tensin@gmail.com>2022-03-10 12:48:59 +0500
commit4a13df61b92b8bf673f8a71d5fa0abf0356a4899 (patch)
tree071a3830ce0f2309e40a4bb16b7dd42018bd852f /include/winapi/pipe.hpp
parentMakefile: remove stupid header, etc. (diff)
downloadwinapi-common-4a13df61b92b8bf673f8a71d5fa0abf0356a4899.tar.gz
winapi-common-4a13df61b92b8bf673f8a71d5fa0abf0356a4899.zip
add Doxygen docs
Diffstat (limited to 'include/winapi/pipe.hpp')
-rw-r--r--include/winapi/pipe.hpp6
1 files changed, 6 insertions, 0 deletions
diff --git a/include/winapi/pipe.hpp b/include/winapi/pipe.hpp
index aec87cd..e4f8624 100644
--- a/include/winapi/pipe.hpp
+++ b/include/winapi/pipe.hpp
@@ -11,13 +11,19 @@
namespace winapi {
+/** @brief Anonymous pipe wrapper. */
class Pipe {
public:
+ /** Create a new pipe. */
Pipe();
+ /** Get the read end of the pipe. */
Handle& read_end() { return m_read_end; }
+ /** @overload */
const Handle& read_end() const { return m_read_end; }
+ /** Get the write end of the pipe. */
Handle& write_end() { return m_write_end; }
+ /** @overload */
const Handle& write_end() const { return m_write_end; }
private: