rearranged doxygen comments

vortexntnu · Nov 7, 2023 · 96b631b · 96b631b
1 parent 6bae14e
commit 96b631b
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/motion/thruster_allocator/include/thruster_allocator/allocator_ros.hpp b/motion/thruster_allocator/include/thruster_allocator/allocator_ros.hpp
@@ -1,3 +1,10 @@
+/**
+ * @file allocator_ros.hpp
+ * @brief ThrusterAllocator class, which
+ * allocates thrust to the ASV's thrusters based on the desired body frame
+ * forces.
+ */
+
 #ifndef VORTEX_ALLOCATOR_ALLOCATOR_ROS_HPP
 #define VORTEX_ALLOCATOR_ALLOCATOR_ROS_HPP
 
@@ -9,12 +16,6 @@
 #include <geometry_msgs/msg/wrench.hpp>
 #include <vortex_msgs/msg/thruster_forces.hpp>
 
-/**
- * @file allocator_ros.hpp
- * @brief ThrusterAllocator class, which
- * allocates thrust to the ASV's thrusters based on the desired body frame
- * forces.
- */
 using namespace std::chrono_literals;
 
 class ThrusterAllocator : public rclcpp::Node {

diff --git a/motion/thruster_allocator/include/thruster_allocator/allocator_utils.hpp b/motion/thruster_allocator/include/thruster_allocator/allocator_utils.hpp
@@ -1,3 +1,9 @@
+/**
+ * @file allocator_utils.hpp
+ * @brief This file contains utility functions for the thruster allocator
+ * module.
+ */
+
 #ifndef VORTEX_ALLOCATOR_ALLOCATOR_UTILS_HPP
 #define VORTEX_ALLOCATOR_ALLOCATOR_UTILS_HPP
 
@@ -8,12 +14,6 @@
 
 #include <vortex_msgs/msg/thruster_forces.hpp>
 
-/**
- * @file allocator_utils.hpp
- * @brief This file contains utility functions for the thruster allocator
- * module.
- */
-
 /**
  * @brief Check if the matrix has any NaN or INF elements.
  *