From 4a13df61b92b8bf673f8a71d5fa0abf0356a4899 Mon Sep 17 00:00:00 2001
From: Egor Tensin <Egor.Tensin@gmail.com>
Date: Thu, 10 Mar 2022 12:39:04 +0500
Subject: add Doxygen docs

---
 include/winapi/pipe.hpp | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'include/winapi/pipe.hpp')

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:
-- 
cgit v1.3