merge `loek/util`

3 files changed, 44 insertions, 44 deletions

diff --git a/src/crepe/Asset.h b/src/crepe/Asset.h
deleted file mode 100644
index 9051c5e..0000000
--- a/src/crepe/Asset.h
+++ /dev/null
@@ -1,41 +0,0 @@
-#pragma once
-
-#include <fstream>
-#include <iostream>
-#include <string>
-
-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:
-	/**
-	 * \brief Get an input stream to the contents of this asset
-	 * \return Input stream with file contents
-	 */
-	std::istream & get_stream();
-	/**
-	 * \brief Get the canonical path to this asset
-	 * \return Canonical path to this asset
-	 */
-	const std::string & get_canonical() const;
-
-private:
-	//! Canonical path to asset
-	const std::string src;
-	//! File handle (stream)
-	std::ifstream file;
-};
-
-} // namespace crepe
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;
 };
 
diff --git a/src/crepe/util/OptionalRef.h b/src/crepe/util/OptionalRef.h
index 1ad3a6d..8417a25 100644
--- a/src/crepe/util/OptionalRef.h
+++ b/src/crepe/util/OptionalRef.h
@@ -12,18 +12,51 @@ namespace crepe {
 template <typename T>
 class OptionalRef {
 public:
+	//! Initialize empty (nonexistant) reference
 	OptionalRef() = default;
-	OptionalRef(T &);
-  OptionalRef<T> & operator=(T &);
+	//! Initialize reference with value
+	OptionalRef(T & ref);
+	/**
+	 * \brief Assign new reference
+	 *
+	 * \param ref Reference to assign
+	 *
+	 * \return Reference to this (required for operator)
+	 */
+  OptionalRef<T> & operator=(T & ref);
+	/**
+	 * \brief Check if this reference is not empty
+	 *
+	 * \returns `true` if reference is set, or `false` if it is not
+	 */
 	explicit operator bool() const noexcept;
 
+	/**
+	 * \brief Assign new reference
+	 *
+	 * \param ref Reference to assign
+	 */
 	void set(T &) noexcept;
+	/**
+	 * \brief Retrieve this reference
+	 *
+	 * \returns Internal reference if it is set
+	 *
+	 * \throws std::runtime_error if this function is called while the reference it not set
+	 */
 	T & get() const;
+	/**
+	 * \brief Make this reference empty
+	 */
 	void clear() noexcept;
 
+	//! Copy constructor
   OptionalRef(const OptionalRef<T> &);
+	//! Move constructor
   OptionalRef(OptionalRef<T> &&);
+	//! Copy assignment
   OptionalRef<T> & operator=(const OptionalRef<T> &);
+	//! Move assignment
   OptionalRef<T> & operator=(OptionalRef<T> &&);
 
 private: