- More Documentation

include/fennec/renderers/vulkan/lib/app_info.h

@@ -46,6 +46,10 @@ struct app_info : private VkApplicationInfo {
 
 // Constructors & Destructor ===========================================================================================
 public:
+
+	/// \name Constructors & Destructor
+	/// @{
+
 	///
 	/// \brief Create a Vulkan application information structure
 	/// \param app_name the name of the application, this cstring must exist for the lifetime of this object
@@ -86,37 +90,58 @@ public:
 	/// \brief Destructor
 	~app_info() noexcept = default;
 
+	/// @}
+
 
 // Assignment Operators ================================================================================================
 public:
 
+	/// \name Assignment Operators
+	/// @{
+
 	///
 	/// \brief Copy Assignment
-	app_info& operator=(const app_info&) noexcept = default;
+	/// \param info The app_info object to move
+	/// \returns A reference to self
+	app_info& operator=(const app_info& info) noexcept = default;
 
 	///
 	/// \brief Move Assignment
-	app_info& operator=(app_info&&)      noexcept = default;
+	/// \param info The app_info object to move
+	/// \returns A reference to self
+	app_info& operator=(app_info&& info) noexcept = default;
+
+	/// @}
 
 
 // Implicit Conversions ================================================================================================
 public:
 
+	/// \name Implicit Conversions
+	/// @{
+
 	///
+	/// \returns \f$this\f$ as if it were a pointer to the underlying type, \f$VkApplicationInfo\f$.
 	operator VkApplicationInfo*() noexcept {
 		return this;
 	}
 
 	///
 	/// \brief Implicit Pointer Conversion
+	/// \returns \f$this\f$ as if it were a pointer to the underlying type, \f$VkApplicationInfo\f$.
 	operator const VkApplicationInfo*() const noexcept {
 		return this;
 	}
 
+	/// @}
+
 
 // Properties ==========================================================================================================
 public:
 
+	/// \name Properties
+	/// @{
+
 	///
 	/// \returns A cstring containing the application name
 	cstring get_app_name() const {
@@ -202,8 +227,10 @@ public:
 		pNext = nullptr;
 	}
 
+	/// @}
 
-// Private Members =====================================================================================================
+
+// Private Member Variables ============================================================================================
 private:
 };
 

include/fennec/renderers/vulkan/vkcontext.h

@@ -32,7 +32,7 @@
 #ifndef FENNEC_PLATFORM_VULKAN_VKCONTEXT_H
 #define FENNEC_PLATFORM_VULKAN_VKCONTEXT_H
 
-#include <fennec/platform/interface/fwd.h>
+#include <fennec/platform/interface/forward.h>
 #include <fennec/renderers/interface/gfxcontext.h>
 
 namespace fennec