aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-11-18 18:10:31 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-11-18 18:10:31 +0100
commit9770b548c5619821d7b6ea7a017df2b5a6898d0a (patch)
treec341271afe911d94ae363ccc270f6d75725813fa /src/crepe/api
parent8d78727d6e7badca16ba7a1328643928a0039569 (diff)
add doxygen comments
Diffstat (limited to 'src/crepe/api')
-rw-r--r--src/crepe/api/Asset.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/crepe/api/Asset.h b/src/crepe/api/Asset.h
index 05dccba..685dd3a 100644
--- a/src/crepe/api/Asset.h
+++ b/src/crepe/api/Asset.h
@@ -1,7 +1,6 @@
#pragma once
#include <string>
-#include <unordered_map>
namespace crepe {
@@ -52,7 +51,16 @@ private:
namespace std {
+//! Hash helper struct
template<> struct hash<const crepe::Asset> {
+ /**
+ * \brief Hash operator for crepe::Asset
+ *
+ * This function hashes a crepe::Asset instance, allowing it to be used as a key in an \c
+ * std::unordered_map.
+ *
+ * \returns Hash value
+ */
size_t operator()(const crepe::Asset & asset) const noexcept;
};