aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/crepe/Asset.h9
1 files changed, 9 insertions, 0 deletions
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: