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/resource.hpp | 2 ++
 1 file changed, 2 insertions(+)

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

diff --git a/include/winapi/resource.hpp b/include/winapi/resource.hpp
index 2f77d3e..8b6e41b 100644
--- a/include/winapi/resource.hpp
+++ b/include/winapi/resource.hpp
@@ -11,6 +11,7 @@
 
 namespace winapi {
 
+/** @brief Resources embedded in a PE (Portable Executable). */
 struct Resource {
     // This is just a pointer to static data.
 
@@ -18,6 +19,7 @@ struct Resource {
 
     Resource(const void* data, std::size_t nb) : data{data}, nb{nb} {}
 
+    /** Extract resource data into a Buffer instance. */
     Buffer copy() const { return {data, nb}; }
 
     const void* data = nullptr;
-- 
cgit v1.2.3