Improve documentation

1 files changed, 25 insertions, 0 deletions

diff --git a/src/binres/binres.hpp b/src/binres/binres.hpp
index 9d2ef85..e2e3f51 100644
--- a/src/binres/binres.hpp
+++ b/src/binres/binres.hpp
@@ -1,7 +1,32 @@
+/**
+ * @file binres.hpp
+ * @author Manzerbredes
+ * @brief Binary resources functions
+ * @version 0.1
+ * @date 2023-05-12
+ * 
+ * @copyright Copyright (c) 2023
+ * 
+ */
 #pragma once
 
 #include "ochess.hpp"
 
+/**
+ * @brief Load an icon from embedded binary resources and rescale it
+ * to a specified @a size
+ *
+ * @param icon The icon name
+ * @param size Scale the icon to the specified size
+ * @return wxBitmap 
+ */
 wxBitmap LoadPNG(std::string icon, wxSize size);
+
+/**
+ * @brief Load an icon from embedded binary resources
+ * 
+ * @param icon 
+ * @return wxBitmap 
+ */
 wxBitmap LoadPNG(std::string icon);