From c40332b990b025d2bd7b94e41184d7f0547da203 Mon Sep 17 00:00:00 2001
From: Loek Le Blansch <loek@pipeframe.xyz>
Date: Sat, 5 Oct 2024 14:33:43 +0200
Subject: add doxygen comments to Asset class

---
 src/crepe/Asset.h | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src')

diff --git a/src/crepe/Asset.h b/src/crepe/Asset.h
index 736ba44..0cb5834 100644
--- a/src/crepe/Asset.h
+++ b/src/crepe/Asset.h
@@ -6,8 +6,17 @@
 
 namespace crepe {
 
+/**
+ * \brief Asset location helper
+ *
+ * This class is used to locate and canonicalize paths to game asset files, and
+ * should *always* be used when retrieving files from disk.
+ */
 class Asset {
 public:
+	/**
+	 * \param src  Unique identifier to asset
+	 */
 	Asset(const std::string & src);
 
 public:
-- 
cgit v1.2.3