Skip to content

Commit

Permalink
Add information about <topic> system paramter
Browse files Browse the repository at this point in the history
Adding some API docs for changes from #1076

Signed-off-by: Kenji Brameld <kenjibrameld@gmail.com>
  • Loading branch information
ijnek committed Aug 28, 2022
1 parent 25bdef6 commit 751eefd
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/systems/joint_state_publisher/JointStatePublisher.hh
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,17 @@ namespace systems
{
/// \brief The JointStatePub system publishes state information for
/// a model. The published message type is ignition::msgs::Model, and the
/// publication topic is "/world/<world_name>/model/<model_name>/state".
/// publication topic is determined by the `<topic>` parameter.
///
/// By default the JointStatePublisher will publish all joints for
/// a model. Use the `<joint_name>` system parameter, described below, to
/// control which joints are published.
///
/// # System Parameters
///
/// `<topic>`: Name of the topic to publish to. This parameter is optional,
/// and if not provided, the joint state will be published to
/// "/world/<world_name>/model/<model_name>/state".
/// `<joint_name>`: Name of a joint to publish. This parameter can be
/// specified multiple times, and is optional. All joints in a model will
/// be published if joint names are not specified.
Expand Down

0 comments on commit 751eefd

Please sign in to comment.