add Doxygen docs

1 files changed, 31 insertions, 1 deletions

diff --git a/include/winapi/handle.hpp b/include/winapi/handle.hpp
index 8ea90aa..b5a7547 100644
--- a/include/winapi/handle.hpp
+++ b/include/winapi/handle.hpp
@@ -16,6 +16,12 @@
 
 namespace winapi {
 
+/**
+ * @brief HANDLE wrapper.
+ *
+ * This class wraps HANDLE, allowing for painless reads and writes from a
+ * random handle.
+ */
 class Handle {
 public:
     Handle() = default;
@@ -29,21 +35,45 @@ public:
     bool is_valid() const;
     static bool is_valid(HANDLE);
 
+    /** Close this handle. */
     void close();
 
+    /** Check if this is a standard console handle. */
     bool is_std() const;
+    /** Check if this is the stdin handle. */
     static Handle std_in();
+    /** Check if this is the stdout handle. */
     static Handle std_out();
+    /** Check if this is the stderr handle. */
     static Handle std_err();
 
+    /** Read everything from this handle. */
     Buffer read() const;
 
     static constexpr std::size_t max_chunk_size = 16 * 1024;
+    /**
+     * Read a chunk from this handle.
+     * @param read_chunk Receives the data read.
+     * @return `true` if there's more data, `false` otherwise.
+     */
     bool read_chunk(Buffer& read_chunk) const;
 
-    void write(const void*, std::size_t nb) const;
+    /**
+     * Write data to this handle.
+     * @param data Pointer to binary data.
+     * @param nb   Data size.
+     */
+    void write(const void* data, std::size_t nb) const;
+    /**
+     * Write data to this handle.
+     * @param buffer Binary data to write.
+     */
     void write(const Buffer& buffer) const;
 
+    /**
+     * Write data to this handle.
+     * @param src Binary data to write.
+     */
     template <typename CharT>
     void write(const std::basic_string<CharT>& src) const {
         write(src.c_str(), src.size() * sizeof(CharT));