Merge pull request #58 from tier4/style/document

style: document
tier4 · Dec 3, 2024 · 3376330 · 3376330
2 parents 5a2c004 + aedfe0c
commit 3376330
Show file tree

Hide file tree

Showing 18 changed files with 120 additions and 120 deletions.
diff --git a/docs/use_case/annotationless_perception.en.md b/docs/use_case/annotationless_perception.en.md
@@ -65,9 +65,9 @@ When the normal condition is not met
 
 Subscribed topics:
 
-| Topic name                                      | Data type                             |
-| ----------------------------------------------- | ------------------------------------- |
-| /perception/perception_online_evaluator/metrics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name                                      | Data type                           |
+| ----------------------------------------------- | ----------------------------------- |
+| /perception/perception_online_evaluator/metrics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/annotationless_perception.ja.md b/docs/use_case/annotationless_perception.ja.md
@@ -65,9 +65,9 @@ metric_valueは現在の値だけで判定され、min, max, meanのmetricsの
 
 Subscribed topics:
 
-| Topic name                                      | Data type                             |
-| ----------------------------------------------- | ------------------------------------- |
-| /perception/perception_online_evaluator/metrics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name                                      | Data type                           |
+| ----------------------------------------------- | ----------------------------------- |
+| /perception/perception_online_evaluator/metrics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/ar_tag_based_localizer.en.md b/docs/use_case/ar_tag_based_localizer.en.md
@@ -34,9 +34,9 @@ The ArTagBasedLocalizer availability evaluation output is marked as `Error` when
 
 Subscribed topics:
 
-| Topic name   | Data type                             |
-| ------------ | ------------------------------------- |
-| /diagnostics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name   | Data type                           |
+| ------------ | ----------------------------------- |
+| /diagnostics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/ar_tag_based_localizer.ja.md b/docs/use_case/ar_tag_based_localizer.ja.md
@@ -36,9 +36,9 @@ ArTagBasedLocalizer Monitorが出力する `/diagnostics` の中から、監視
 
 Subscribed topics:
 
-| Topic name   | Data type                             |
-| ------------ | ------------------------------------- |
-| /diagnostics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name   | Data type                           |
+| ------------ | ----------------------------------- |
+| /diagnostics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/eagleye.en.md b/docs/use_case/eagleye.en.md
@@ -33,9 +33,9 @@ The Eagleye availability evaluation output is marked as `Error` when conditions
 
 Subscribed topics:
 
-| Topic name   | Data type                             |
-| ------------ | ------------------------------------- |
-| /diagnostics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name   | Data type                           |
+| ------------ | ----------------------------------- |
+| /diagnostics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/eagleye.ja.md b/docs/use_case/eagleye.ja.md
@@ -43,9 +43,9 @@ Eagleye Monitorが出力する `/diagnostics` の中から、監視トピック
 
 Subscribed topics:
 
-| Topic name   | Data type                             |
-| ------------ | ------------------------------------- |
-| /diagnostics | diagnostic_msgs::msg::DiagnosticArray |
+| Topic name   | Data type                           |
+| ------------ | ----------------------------------- |
+| /diagnostics | diagnostic_msgs/msg/DiagnosticArray |
 
 Published topics:
 

diff --git a/docs/use_case/localization.en.md b/docs/use_case/localization.en.md
@@ -82,23 +82,23 @@ The NDT availability evaluation output is marked as `Error` when conditions for
 
 Subscribed topics:
 
-| Topic name                                                           | Data type                             |
-| -------------------------------------------------------------------- | ------------------------------------- |
-| /diagnostics                                                         | diagnostic_msgs::msg::DiagnosticArray |
-| /localization/pose_estimator/transform_probability                   | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/nearest_voxel_transformation_likelihood | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/initial_to_result_relative_pose         | geometry_msgs::msg::PoseStamped       |
-| /localization/pose_estimator/exe_time_ms                             | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/iteration_num                           | tier4_debug_msgs::msg::Int32Stamped   |
-| /tf                                                                  | tf2_msgs/msg/TFMessage                |
-| /localization/util/downsample/pointcloud                             | sensor_msgs::msg::PointCloud2         |
-| /localization/pose_estimator/points_aligned                          | sensor_msgs::msg::PointCloud2         |
+| Topic name                                                           | Data type                           |
+| -------------------------------------------------------------------- | ----------------------------------- |
+| /diagnostics                                                         | diagnostic_msgs/msg/DiagnosticArray |
+| /localization/pose_estimator/transform_probability                   | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/nearest_voxel_transformation_likelihood | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/initial_to_result_relative_pose         | geometry_msgs/msg/PoseStamped       |
+| /localization/pose_estimator/exe_time_ms                             | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/iteration_num                           | tier4_debug_msgs/msg/Int32Stamped   |
+| /tf                                                                  | tf2_msgs/msg/TFMessage              |
+| /localization/util/downsample/pointcloud                             | sensor_msgs/msg/PointCloud2         |
+| /localization/pose_estimator/points_aligned                          | sensor_msgs/msg/PointCloud2         |
 
 Published topics:
 
-| Topic name                                             | Data type                        |
-| ------------------------------------------------------ | -------------------------------- |
-| /driving_log_replayer_v2/localization/lateral_distance | example_interfaces::msg::Float64 |
+| Topic name                                             | Data type                      |
+| ------------------------------------------------------ | ------------------------------ |
+| /driving_log_replayer_v2/localization/lateral_distance | example_interfaces/msg/Float64 |
 
 ## Service name and data type used by the evaluation node
 

diff --git a/docs/use_case/localization.ja.md b/docs/use_case/localization.ja.md
@@ -82,23 +82,23 @@ Component State Monitorが出力する `/diagnostics` の中から、監視ト
 
 Subscribed topics:
 
-| topic 名                                                             | データ型                              |
-| -------------------------------------------------------------------- | ------------------------------------- |
-| /diagnostics                                                         | diagnostic_msgs::msg::DiagnosticArray |
-| /localization/pose_estimator/transform_probability                   | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/nearest_voxel_transformation_likelihood | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/initial_to_result_relative_pose         | geometry_msgs::msg::PoseStamped       |
-| /localization/pose_estimator/exe_time_ms                             | tier4_debug_msgs::msg::Float32Stamped |
-| /localization/pose_estimator/iteration_num                           | tier4_debug_msgs::msg::Int32Stamped   |
-| /tf                                                                  | tf2_msgs/msg/TFMessage                |
-| /localization/util/downsample/pointcloud                             | sensor_msgs::msg::PointCloud2         |
-| /localization/pose_estimator/points_aligned                          | sensor_msgs::msg::PointCloud2         |
+| topic 名                                                             | データ型                            |
+| -------------------------------------------------------------------- | ----------------------------------- |
+| /diagnostics                                                         | diagnostic_msgs/msg/DiagnosticArray |
+| /localization/pose_estimator/transform_probability                   | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/nearest_voxel_transformation_likelihood | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/initial_to_result_relative_pose         | geometry_msgs/msg/PoseStamped       |
+| /localization/pose_estimator/exe_time_ms                             | tier4_debug_msgs/msg/Float32Stamped |
+| /localization/pose_estimator/iteration_num                           | tier4_debug_msgs/msg/Int32Stamped   |
+| /tf                                                                  | tf2_msgs/msg/TFMessage              |
+| /localization/util/downsample/pointcloud                             | sensor_msgs/msg/PointCloud2         |
+| /localization/pose_estimator/points_aligned                          | sensor_msgs/msg/PointCloud2         |
 
 Published topics:
 
-| topic 名                                               | データ型                         |
-| ------------------------------------------------------ | -------------------------------- |
-| /driving_log_replayer_v2/localization/lateral_distance | example_interfaces::msg::Float64 |
+| topic 名                                               | データ型                       |
+| ------------------------------------------------------ | ------------------------------ |
+| /driving_log_replayer_v2/localization/lateral_distance | example_interfaces/msg/Float64 |
 
 ## 評価ノードが使用する Service 名とデータ型
 

diff --git a/docs/use_case/obstacle_segmentation.en.md b/docs/use_case/obstacle_segmentation.en.md
@@ -73,23 +73,23 @@ The state is `Error` when any point was found in the non-detection area.
 
 Subscribed topics:
 
-| Topic name                                      | Data type                                 |
-| ----------------------------------------------- | ----------------------------------------- |
-| /perception/obstacle_segmentation/pointcloud    | sensor_msgs::msg::PointCloud2             |
-| /diagnostics                                    | diagnostic_msgs::msg::DiagnosticArray     |
-| /tf                                             | tf2_msgs/msg/TFMessage                    |
-| /planning/scenario_planning/status/stop_reasons | tier4_planning_msgs::msg::StopReasonArray |
-| /planning/scenario_planning/trajectory          | autoware_planning_msgs::msg::Trajectory   |
+| Topic name                                      | Data type                               |
+| ----------------------------------------------- | --------------------------------------- |
+| /perception/obstacle_segmentation/pointcloud    | sensor_msgs/msg/PointCloud2             |
+| /diagnostics                                    | diagnostic_msgs/msg/DiagnosticArray     |
+| /tf                                             | tf2_msgs/msg/TFMessage                  |
+| /planning/scenario_planning/status/stop_reasons | tier4_planning_msgs/msg/StopReasonArray |
+| /planning/scenario_planning/trajectory          | autoware_planning_msgs/msg/Trajectory   |
 
 Published topics:
 
-| Topic name                                    | Data type                            |
-| --------------------------------------------- | ------------------------------------ |
-| /driving_log_replayer_v2/marker/detection     | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/marker/non_detection | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/pcd/detection        | sensor_msgs::msg::PointCloud2        |
-| /driving_log_replayer_v2/pcd/non_detection    | sensor_msgs::msg::PointCloud2        |
-| /planning/mission_planning/goal               | geometry_msgs::msg::PoseStamped      |
+| Topic name                                    | Data type                          |
+| --------------------------------------------- | ---------------------------------- |
+| /driving_log_replayer_v2/marker/detection     | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/marker/non_detection | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/pcd/detection        | sensor_msgs/msg/PointCloud2        |
+| /driving_log_replayer_v2/pcd/non_detection    | sensor_msgs/msg/PointCloud2        |
+| /planning/mission_planning/goal               | geometry_msgs/msg/PoseStamped      |
 
 ## Arguments passed to logging_simulator.launch
 

diff --git a/docs/use_case/obstacle_segmentation.ja.md b/docs/use_case/obstacle_segmentation.ja.md
@@ -74,23 +74,23 @@ topic の subscribe 1 回につき、以下に記述する判定結果が出力
 
 Subscribed topics:
 
-| topic 名                                        | データ型                                  |
-| ----------------------------------------------- | ----------------------------------------- |
-| /perception/obstacle_segmentation/pointcloud    | sensor_msgs::msg::PointCloud2             |
-| /diagnostics                                    | diagnostic_msgs::msg::DiagnosticArray     |
-| /tf                                             | tf2_msgs/msg/TFMessage                    |
-| /planning/scenario_planning/status/stop_reasons | tier4_planning_msgs::msg::StopReasonArray |
-| /planning/scenario_planning/trajectory          | autoware_planning_msgs::msg::Trajectory   |
+| topic 名                                        | データ型                                |
+| ----------------------------------------------- | --------------------------------------- |
+| /perception/obstacle_segmentation/pointcloud    | sensor_msgs/msg/PointCloud2             |
+| /diagnostics                                    | diagnostic_msgs/msg/DiagnosticArray     |
+| /tf                                             | tf2_msgs/msg/TFMessage                  |
+| /planning/scenario_planning/status/stop_reasons | tier4_planning_msgs/msg/StopReasonArray |
+| /planning/scenario_planning/trajectory          | autoware_planning_msgs/msg/Trajectory   |
 
 Published topics:
 
-| topic 名                                      | データ型                             |
-| --------------------------------------------- | ------------------------------------ |
-| /driving_log_replayer_v2/marker/detection     | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/marker/non_detection | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/pcd/detection        | sensor_msgs::msg::PointCloud2        |
-| /driving_log_replayer_v2/pcd/non_detection    | sensor_msgs::msg::PointCloud2        |
-| /planning/mission_planning/goal               | geometry_msgs::msg::PoseStamped      |
+| topic 名                                      | データ型                           |
+| --------------------------------------------- | ---------------------------------- |
+| /driving_log_replayer_v2/marker/detection     | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/marker/non_detection | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/pcd/detection        | sensor_msgs/msg/PointCloud2        |
+| /driving_log_replayer_v2/pcd/non_detection    | sensor_msgs/msg/PointCloud2        |
+| /planning/mission_planning/goal               | geometry_msgs/msg/PoseStamped      |
 
 ## logging_simulator.launch に渡す引数
 

diff --git a/docs/use_case/perception.en.md b/docs/use_case/perception.en.md
@@ -127,10 +127,10 @@ Subscribed topics:
 
 Published topics:
 
-| Topic name                                   | Data type                            |
-| -------------------------------------------- | ------------------------------------ |
-| /driving_log_replayer_v2/marker/ground_truth | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/marker/results      | visualization_msgs::msg::MarkerArray |
+| Topic name                                   | Data type                          |
+| -------------------------------------------- | ---------------------------------- |
+| /driving_log_replayer_v2/marker/ground_truth | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/marker/results      | visualization_msgs/msg/MarkerArray |
 
 ## Arguments passed to logging_simulator.launch
 

diff --git a/docs/use_case/perception.ja.md b/docs/use_case/perception.ja.md
@@ -123,10 +123,10 @@ Subscribed topics:
 
 Published topics:
 
-| topic 名                                     | データ型                             |
-| -------------------------------------------- | ------------------------------------ |
-| /driving_log_replayer_v2/marker/ground_truth | visualization_msgs::msg::MarkerArray |
-| /driving_log_replayer_v2/marker/results      | visualization_msgs::msg::MarkerArray |
+| topic 名                                     | データ型                           |
+| -------------------------------------------- | ---------------------------------- |
+| /driving_log_replayer_v2/marker/ground_truth | visualization_msgs/msg/MarkerArray |
+| /driving_log_replayer_v2/marker/results      | visualization_msgs/msg/MarkerArray |
 
 ## logging_simulator.launch に渡す引数
 

diff --git a/docs/use_case/performance_diag.en.md b/docs/use_case/performance_diag.en.md
@@ -60,21 +60,21 @@ If the scenario type is FP and the level in the diagnostic information is ERROR.
 
 Subscribed topics:
 
-| Topic name                                   | Data type                             |
-| -------------------------------------------- | ------------------------------------- |
-| /perception/obstacle_segmentation/pointcloud | sensor_msgs::msg::PointCloud2         |
-| /diagnostics                                 | diagnostic_msgs::msg::DiagnosticArray |
-| /tf                                          | tf2_msgs/msg/TFMessage                |
+| Topic name                                   | Data type                           |
+| -------------------------------------------- | ----------------------------------- |
+| /perception/obstacle_segmentation/pointcloud | sensor_msgs/msg/PointCloud2         |
+| /diagnostics                                 | diagnostic_msgs/msg/DiagnosticArray |
+| /tf                                          | tf2_msgs/msg/TFMessage              |
 
 Published topics:
 
-| Topic name                                                  | Data type                        |
-| ----------------------------------------------------------- | -------------------------------- |
-| /driving_log_replayer_v2/visibility/value                   | example_interfaces::msg::Float64 |
-| /driving_log_replayer_v2/visibility/level                   | example_interfaces::msg::Byte    |
-| /driving_log_replayer_v2/blockage/{lidar_name}/ground/ratio | example_interfaces::msg::Float64 |
-| /driving_log_replayer_v2/blockage/{lidar_name}/sky/ratio    | example_interfaces::msg::Float64 |
-| /driving_log_replayer_v2/blockage/{lidar_name}/level        | example_interfaces::msg::Byte    |
+| Topic name                                                  | Data type                      |
+| ----------------------------------------------------------- | ------------------------------ |
+| /driving_log_replayer_v2/visibility/value                   | example_interfaces/msg/Float64 |
+| /driving_log_replayer_v2/visibility/level                   | example_interfaces/msg/Byte    |
+| /driving_log_replayer_v2/blockage/{lidar_name}/ground/ratio | example_interfaces/msg/Float64 |
+| /driving_log_replayer_v2/blockage/{lidar_name}/sky/ratio    | example_interfaces/msg/Float64 |
+| /driving_log_replayer_v2/blockage/{lidar_name}/level        | example_interfaces/msg/Byte    |
 
 {lidar_name} contains the name of the mounted lidar.