docs: fix most doxygen warnings

core/include/cubos/core/ecs/blueprint.hpp

@@ -39,22 +39,12 @@ namespace cubos::core::ecs
     {
     public:
         /// @brief Function used by @ref instantiate to create entities.
-        /// @param userData User data passed into @ref instantiate.
-        /// @param name Entity name.
-        /// @return Instantiated entity.
         using Create = Entity (*)(void* userData, std::string name);
 
         /// @brief Function used by @ref instantiate to add components to entities.
-        /// @param userData User data passed into @ref instantiate.
-        /// @param entity Entity.
-        /// @param component Component.
         using Add = void (*)(void* userData, Entity entity, memory::AnyValue component);
 
         /// @brief Function used by @ref instantiate to add relations to entities.
-        /// @param userData User data passed into @ref instantiate.
-        /// @param fromEntity From entity.
-        /// @param toEntity To entity.
-        /// @param relation Relation.
         using Relate = void (*)(void* userData, Entity fromEntity, Entity toEntity, memory::AnyValue relation);
 
         /// @brief Creates a new entity in the blueprint and returns it.

core/include/cubos/core/ecs/cubos.hpp

@@ -133,7 +133,7 @@ namespace cubos::core::ecs
         Cubos& addComponent();
 
         /// @brief Adds a new relation type to the engine.
-        /// @tparam C Type of the relation.
+        /// @tparam R Type of the relation.
         /// @return Reference to this object, for chaining.
         template <typename R>
         Cubos& addRelation()

core/include/cubos/core/ecs/system/arguments/query.hpp

@@ -33,7 +33,7 @@ namespace cubos::core::ecs
         using Iterator = typename QueryData<Ts...>::View::Iterator;
 
         /// @brief Constructs.
-        /// @param data Query data view.
+        /// @param view Query data view.
         Query(typename QueryData<Ts...>::View view)
             : mView{view}
         {

core/include/cubos/core/ecs/system/dispatcher.hpp

@@ -74,12 +74,11 @@ namespace cubos::core::ecs
         void tagSetBeforeTag(const std::string& tag);
 
         /// @brief Adds a condition to the current tag.
-        /// @tparam F Condition type.
         /// @param condition Condition to add.
         void tagAddCondition(ecs::System<bool> condition);
 
         /// @brief Adds a repeat condition to the current tag.
-        /// @param func Condition to add.
+        /// @param condition Condition to add.
         void tagRepeatWhile(ecs::System<bool> condition);
 
         /// @brief Adds a (sub)group to the current group.

core/include/cubos/core/ecs/table/dense/registry.hpp

@@ -31,7 +31,7 @@ namespace cubos::core::ecs
         ///
         /// @param archetype Archetype identifier.
         /// @param graph Archetype graph used to initialize the table, if necessary.
-        /// @param type Type registry used to initialize the table, if necessary.
+        /// @param types Type registry used to initialize the table, if necessary.
         /// @return Reference to table.
         DenseTable& create(ArchetypeId archetype, ArchetypeGraph& graph, Types& types);
 

core/include/cubos/core/ecs/table/sparse_relation/registry.hpp

@@ -70,7 +70,7 @@ namespace cubos::core::ecs
         /// Creates the table if it doesn't exist already.
         ///
         /// @param id Identifier.
-        /// @param type Type registry used to initialize the table, if necessary.
+        /// @param types Type registry used to initialize the table, if necessary.
         /// @return Reference to table.
         SparseRelationTable& create(SparseRelationTableId id, Types& types);
 

core/include/cubos/core/ecs/types.hpp

@@ -66,7 +66,7 @@ namespace cubos::core::ecs
         const reflection::Type& type(DataTypeId id) const;
 
         /// @brief Checks if a data type is registered.
-        /// @param name Data type.
+        /// @param type Data type.
         /// @return Whether the data type is registered.
         bool contains(const reflection::Type& type) const;
 

core/include/cubos/core/io/window.hpp

@@ -208,7 +208,7 @@ namespace cubos::core::io
         virtual MouseState mouseState() const = 0;
 
         /// @brief Gets the position of the mouse cursor.
-        /// @param position Position of the mouse cursor, in screen coordinates.
+        /// @return Position of the mouse cursor, in screen coordinates.
         virtual glm::ivec2 getMousePosition() = 0;
 
         /// @brief Sets the position of the mouse cursor.

core/include/cubos/core/memory/any_vector.hpp

@@ -51,11 +51,11 @@ namespace cubos::core::memory
 
         /// @brief Pushes a new copy-constructed element to the back of the vector.
         /// @note Aborts if @ref elementType() is not copy-constructible.
-        /// @param element Element to copy.
+        /// @param value Element to copy.
         void pushCopy(const void* value);
 
         /// @brief Pushes a new move-constructed element to the back of the vector.
-        /// @param element Element to move.
+        /// @param value Element to move.
         void pushMove(void* value);
 
         /// @brief Overwrites the element at the given index with a new default-constructed element.
@@ -66,13 +66,13 @@ namespace cubos::core::memory
         /// @brief Overwrites the element at the given index with a new copy-constructed element.
         /// @note Aborts if @ref elementType() is not copy-constructible.
         /// @param index Element index.
-        /// @param element Element to copy.
+        /// @param value Element to copy.
         void setCopy(std::size_t index, const void* value);
 
         /// @brief Overwrites the element at the given index with a new move-constructed element.
         /// @note Aborts if @ref elementType() is not move-constructible.
         /// @param index Element index.
-        /// @param element Element to move.
+        /// @param value Element to move.
         void setMove(std::size_t index, void* value);
 
         /// @brief Removes the last element from the vector.

core/include/cubos/core/reflection/traits/enum.hpp

@@ -50,7 +50,7 @@ namespace cubos::core::reflection
 
         /// @brief Converts a string to a value of a specified type.
         /// @param[in,out] value Variable to store the converted value.
-        /// @param string String to be converted to the specified value type.
+        /// @param str String to be converted to the specified value type.
         /// @return Whether the conversion was successful, false otherwise.
         template <typename T>
         static bool fromString(T& value, const std::string& str)

core/include/cubos/core/reflection/traits/nullable.hpp

@@ -21,8 +21,8 @@ namespace cubos::core::reflection
         using SetToNull = void (*)(void* instance);
 
         /// @brief Constructs.
-        /// @param into IsNull.
-        /// @param from SetToNull.
+        /// @param isNull IsNull.
+        /// @param setToNull SetToNull.
         NullableTrait(IsNull isNull, SetToNull setToNull);
 
         /// @brief Checks if the given value represents null.

core/samples/reflection/traits/enum/page.md

@@ -16,7 +16,7 @@ Output:
 
 @snippet reflection/traits/enum/main.cpp Using the type
 
-```
+```txt
 [2023-11-19 13:09:36.117] [info] [main.cpp:59] Variant 'Red'
 [2023-11-19 13:09:36.118] [info] [main.cpp:59] Variant 'Green'
 [2023-11-19 13:09:36.119] [info] [main.cpp:59] Variant 'Blue'

docs/pages/2_features/quadrados.md

@@ -85,7 +85,7 @@ $ quadrados convert car2.qb -p main.pal -g car2.grd
 
 If this fails, you may see the error message:
 
-```
+```txt
 Failed to convert grid 0 from its palette to the palette chosen.
 ```
 

engine/include/cubos/engine/gizmos/gizmos.hpp

@@ -127,19 +127,16 @@ namespace cubos::engine
         /// @return Whether the mouse button is over a gizmo.
         bool hovered(const std::string& id) const;
 
-        /// @brief Registers gizmo interaction. Called automatically by an internal system.
-        /// @param id Gizmo being interacted with.
+        /// @brief Notifies that a given gizmo is being hovered. Called automatically by an internal system.
+        /// @param hovered Gizmo being hovered.
         /// @param pressed Whether the mouse left button is pressed.
         void handleInput(uint32_t hovered, bool pressed);
 
-        /// @brief Registers gizmo interaction. Called automatically by an internal system.
-        /// @param id Gizmo being interacted with.
-        /// @param pressed Whether the mouse left button is pressed.
+        /// @brief Notifies that a given gizmo is locked.
+        /// @param locked Gizmo being locked.
         void setLocked(uint32_t locked);
 
-        /// @brief Registers gizmo interaction. Called automatically by an internal system.
-        /// @param id Gizmo being interacted with.
-        /// @param pressed Whether the mouse left button is pressed.
+        /// @brief Notifies that the previously locked gizmo is no longer locked.
         void releaseLocked();
 
         /// @brief Class that describes a type of gizmo

engine/include/cubos/engine/imgui/data_inspector.hpp

@@ -28,7 +28,6 @@ namespace cubos::engine
 
         /// @copybrief show
         /// @tparam T Value type.
-        /// @param name Value name.
         /// @param value Pointer to value.
         template <typename T>
         void show(const T& value)

engine/include/cubos/engine/screen_picker/screen_picker.hpp

@@ -17,7 +17,7 @@ namespace cubos::engine
     {
     public:
         /// @brief Initializes ScreenPicker for a render device.
-        /// @param renderDevice The current Render device being used.
+        /// @param currentRenderDevice Current Render device being used.
         /// @param size The size of the window in pixels.
         void init(cubos::core::gl::RenderDevice* currentRenderDevice, glm::ivec2 size);
 

engine/samples/events/main.cpp

@@ -48,7 +48,7 @@ int main()
             CUBOS_INFO("D read {}", event.value);
         }
     });
-    /// [Event reader system]
+    /// [Event reader systems]
 
     /// [Event writer system]
     cubos.system("B").tagged("b").call([](EventWriter<MyEvent> writer, State& state, ShouldQuit& quit) {