diff options
| author | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-05 14:33:43 +0200 |
|---|---|---|
| committer | Loek Le Blansch <loek@pipeframe.xyz> | 2024-10-05 14:33:43 +0200 |
| commit | c40332b990b025d2bd7b94e41184d7f0547da203 (patch) | |
| tree | 49c798ea49af262d3f898486d2c22e7d3406cfde | |
| parent | b99e38badb82c5cc79771a77c5f6ea180c67ee4f (diff) | |
add doxygen comments to Asset class
| -rw-r--r-- | src/crepe/Asset.h | 9 |
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: |