More comments added. Still WIP.

Author: Rinzii

lib/render/include/facade/render/gui.hpp

@@ -4,6 +4,9 @@
 #include <facade/vk/gfx.hpp>
 
 namespace facade {
+/// 
+/// \brief Creates a window and a renderer.
+/// 
 class Gui {
   public:
 	struct InitInfo {

lib/render/include/facade/render/renderer.hpp

@@ -8,39 +8,59 @@
 #include <memory>
 
 namespace facade {
+	
+///
+/// \brief Handles all information about the frame and what is happening.
+///
 struct FrameStats {
+	
+	///
+	/// \brief Name of the GPU
+	///
 	std::string_view gpu_name{};
+
 	///
 	/// \brief Total frames so far
 	///
 	std::uint64_t frame_counter{};
+	
 	///
 	/// \brief Triangles drawn in previous frame
 	///
 	std::uint64_t triangles{};
+
 	///
 	/// \brief Draw calls in previous frame
 	///
 	std::uint32_t draw_calls{};
+	
 	///
 	/// \brief Framerate (until previous frame)
 	///
 	std::uint32_t fps{};
+	
 	///
 	/// \brief Current present mode
 	///
 	vk::PresentModeKHR mode{};
+	
 	///
 	/// \brief Multi-sampled anti-aliasing level
 	///
 	vk::SampleCountFlagBits msaa{};
 };
 
+///
+/// \brief
+///
 struct RendererCreateInfo {
 	std::size_t command_buffers{1};
 	std::uint8_t desired_msaa{1};
 };
 
+///
+/// \brief Creates a window and a renderer.
+///
 class Renderer {
   public:
 	using CreateInfo = RendererCreateInfo;

lib/scene/include/facade/scene/camera.hpp

@@ -12,6 +12,10 @@ struct ViewPlane {
 	float far{};
 };
 
+////////////////////////////////////////////////////////////
+/// \brief A camera inside of a 3d plane
+///
+////////////////////////////////////////////////////////////
 struct Camera {
 	struct Perspective {
 		ViewPlane view_plane{1.0f, 1000.0f};

lib/scene/include/facade/scene/id.hpp

@@ -2,11 +2,21 @@
 #include <cstdint>
 
 namespace facade {
+////////////////////////////////////////////////////////////
+/// \brief A ID assigned to items inside of the GLTF viewer.
+///
+////////////////////////////////////////////////////////////
 template <typename T>
 class Id {
   public:
 	using id_type = std::size_t;
 
+	////////////////////////////////////////////////////////////
+	/// \brief ADD MORE INFO.
+	///
+	/// \param value ADD MORE INFO.
+	///
+	////////////////////////////////////////////////////////////
 	constexpr Id(std::size_t value = {}) : m_value(value) {}
 
 	constexpr std::size_t value() const { return m_value; }