Finish up API documentation

geometry_msgs/msg/InertiaStamped.msg

@@ -1,2 +1,4 @@
+# An Inertia with a time stamp and reference frame.
+
 std_msgs/Header header
 Inertia inertia

geometry_msgs/msg/Point32.msg

@@ -1,5 +1,5 @@
 # This contains the position of a point in free space(with 32 bits of precision).
-# It is recommeded to use Point wherever possible instead of Point32.
+# It is recommended to use Point wherever possible instead of Point32.
 #
 # This recommendation is to promote interoperability.
 #
@@ -8,4 +8,4 @@
 
 float32 x
 float32 y
-float32 z
+float32 z

geometry_msgs/msg/TransformStamped.msg

@@ -7,8 +7,13 @@
 #
 # The child_frame_id is necessary in addition to the frame_id
 # in the Header to communicate the full reference for the transform
-# in a self contained message. 
+# in a self contained message.
 
+# The frame id in the header is used as the reference frame of this transform.
 std_msgs/Header header
-string child_frame_id # the frame id of the child frame
+
+# The frame id of the child frame to which this transform points.
+string child_frame_id
+
+# Translation and rotation in 3-dimensions of child_frame_id from header.frame_id.
 Transform transform

nav_msgs/msg/GridCells.msg

@@ -1,7 +1,12 @@
 # An array of cells in a 2D grid
 
 std_msgs/Header header
+
+# Width of each cell
 float32 cell_width
+
+# Height of each cell
 float32 cell_height
+
 # Each cell is represented by the Point at the center of the cell
 geometry_msgs/Point[] cells

nav_msgs/msg/Odometry.msg

@@ -2,7 +2,14 @@
 # The pose in this message should be specified in the coordinate frame given by header.frame_id
 # The twist in this message should be specified in the coordinate frame given by the child_frame_id
 
+# Includes the frame id of the pose parent.
 std_msgs/Header header
+
+# Frame id the pose points to. The twist is in this coordinate frame.
 string child_frame_id
+
+# Estimated pose that is typically relative to a fixed world frame.
 geometry_msgs/PoseWithCovariance pose
+
+# Estimated linear and angular velocity relative to child_frame_id.
 geometry_msgs/TwistWithCovariance twist

nav_msgs/msg/Path.msg

@@ -1,4 +1,7 @@
 # An array of poses that represents a Path for a robot to follow.
 
+# Indicates the frame_id of the path.
 std_msgs/Header header
+
+# Array of poses to follow.
 geometry_msgs/PoseStamped[] poses

nav_msgs/srv/GetMap.srv

@@ -1,3 +1,4 @@
 # Get the map as a nav_msgs/OccupancyGrid
 ---
+# The current map hosted by this map service.
 OccupancyGrid map

nav_msgs/srv/GetPlan.srv

@@ -10,4 +10,5 @@ geometry_msgs/PoseStamped goal
 # relax the constraint in x and y before failing.
 float32 tolerance
 ---
+# Array of poses from start to goal if one was successfully found.
 Path plan

nav_msgs/srv/SetMap.srv

@@ -1,6 +1,11 @@
 # Set a new map together with an initial pose
+
+# Requested 2D map to be set.
 nav_msgs/OccupancyGrid map
+
+# Estimated initial pose when setting new map.
 geometry_msgs/PoseWithCovarianceStamped initial_pose
 ---
-bool success
 
+# True if the map was successfully set, false otherwise.
+bool success

trajectory_msgs/msg/JointTrajectory.msg

@@ -1,3 +1,11 @@
+# The header is used to specify the coordinate frame and the reference time for
+# the trajectory durations
 std_msgs/Header header
+
+# The names of the active joints in each trajectory point. These names are
+# ordered and must correspond to the values in each trajectory point.
 string[] joint_names
+
+# Array of trajectory points, which describe the positions, velocities,
+# accelerations and/or efforts of the joints at each time point.
 JointTrajectoryPoint[] points

trajectory_msgs/msg/JointTrajectoryPoint.msg

@@ -2,8 +2,25 @@
 # or positions[, effort] for the trajectory to be executed.
 # All specified values are in the same order as the joint names in JointTrajectory.msg.
 
+# Single DOF joint positions for each joint relative to their "0" position.
+# The units depend on the specific joint type: radians for revolute or
+# continuous joints, and meters for prismatic joints.
 float64[] positions
+
+# The rate of change in position of each joint. Units are joint type dependent.
+# Radians/second for revolute or continuous joints, and meters/second for
+# prismatic joints.
 float64[] velocities
+
+# Rate of change in velocity of each joint. Units are joint type dependent.
+# Radians/second^2 for revolute or continuous joints, and meters/second^2 for
+# prismatic joints.
 float64[] accelerations
+
+# The torque or the force to be applied at each joint. For revolute/continuous
+# joints effort denotes a torque in newton-meters. For prismatic joints, effort
+# denotes a force in newtons.
 float64[] effort
+
+# Desired time from the trajectory start to arrive at this trajectory point.
 builtin_interfaces/Duration time_from_start

trajectory_msgs/msg/MultiDOFJointTrajectoryPoint.msg

@@ -7,4 +7,5 @@ geometry_msgs/Twist[] velocities
 # There can be an acceleration specified for the origin of the joint.
 geometry_msgs/Twist[] accelerations
 
+# Desired time from the trajectory start to arrive at this trajectory point.
 builtin_interfaces/Duration time_from_start