update file comment

kerikun11 · May 4, 2020 · 3f42b29 · 3f42b29
1 parent 69a64fe
commit 3f42b29
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 10 deletions.
diff --git a/examples/accel/main.cpp b/examples/accel/main.cpp
@@ -1,3 +1,9 @@
+/**
+ * @file main.cpp
+ * @author Ryotaro Onuki (kerikun11+github@gmail.com)
+ * @brief This file evaluates the performance of acceleration curves.
+ * @date 2020-05-04
+ */
 #include "accel_designer.h"
 
 #include <chrono>

diff --git a/examples/continuous/main.cpp b/examples/continuous/main.cpp
@@ -1,3 +1,9 @@
+/**
+ * @file main.cpp
+ * @author Ryotaro Onuki (kerikun11+github@gmail.com)
+ * @brief This file evaluates the performance of acceleration curves.
+ * @date 2020-05-04
+ */
 #include "accel_designer.h"
 
 #include "feedback_controller.h"

diff --git a/examples/shape/main.cpp b/examples/shape/main.cpp
@@ -1,3 +1,9 @@
+/**
+ * @file main.cpp
+ * @author Ryotaro Onuki (kerikun11+github@gmail.com)
+ * @brief This file generates slalom shapes for each turn of the micromouse.
+ * @date 2020-05-04
+ */
 #include "slalom.h"
 
 #include <filesystem>
@@ -42,8 +48,8 @@ void printDefinition(std::ostream &os, const std::string &name,
 }
 
 void printDefinitions() {
-  for (const auto &e : shapes)
-    printDefinition(std::cout, e.first, e.second);
+  for (const auto &[name, shape] : shapes)
+    printDefinition(std::cout, name, shape);
   std::cout << std::endl;
 }
 
@@ -99,14 +105,14 @@ void printTrajectory() {
 }
 
 void printTable() {
-  for (const auto &e : shapes) {
-    std::cout << "|" << e.first;
-    std::cout << "|" << e.second.total.th / M_PI * 180;
-    std::cout << "|(" << e.second.total.x << "," << e.second.total.y << ")";
-    std::cout << "|(" << e.second.curve.x << "," << e.second.curve.y << ")";
-    std::cout << "|" << e.second.v_ref;
-    std::cout << "|" << e.second.straight_prev;
-    std::cout << "|" << e.second.straight_post;
+  for (const auto &[name, shape] : shapes) {
+    std::cout << "|" << name;
+    std::cout << "|" << shape.total.th / M_PI * 180;
+    std::cout << "|(" << shape.total.x << "," << shape.total.y << ")";
+    std::cout << "|(" << shape.curve.x << "," << shape.curve.y << ")";
+    std::cout << "|" << shape.v_ref;
+    std::cout << "|" << shape.straight_prev;
+    std::cout << "|" << shape.straight_post;
     std::cout << "|" << std::endl;
   }
   std::cout << std::endl;

diff --git a/examples/slalom/main.cpp b/examples/slalom/main.cpp
@@ -1,3 +1,9 @@
+/**
+ * @file main.cpp
+ * @author Ryotaro Onuki (kerikun11+github@gmail.com)
+ * @brief slalom trajectory generation example
+ * @date 2020-05-04
+ */
 #include "slalom.h"
 
 #include <cmath>

diff --git a/examples/trajectory/main.cpp b/examples/trajectory/main.cpp
@@ -1,3 +1,9 @@
+/**
+ * @file main.cpp
+ * @author Ryotaro Onuki (kerikun11+github@gmail.com)
+ * @brief trajectory tracking
+ * @date 2020-05-04
+ */
 #include "straight.h"
 #include "trajectory_tracker.h"