Skip to content

Commit

Permalink
exclude comment lines from doxygen snippet
Browse files Browse the repository at this point in the history
Signed-off-by: Mabel Zhang <[email protected]>
  • Loading branch information
mabelzhang committed Oct 31, 2023
1 parent 3cd48ff commit 27198c5
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/systems/apply_joint_force/ApplyJointForce.cc
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,24 @@ class gz::sim::systems::ApplyJointForcePrivate
/// \brief Gazebo communication node.
public: transport::Node node;

//! [jointEntityDeclaration]
/// \brief Joint Entity
//! [jointEntityDeclaration]
public: Entity jointEntity;
//! [jointEntityDeclaration]

/// \brief Joint name
public: std::string jointName;

//! [forceDeclaration]
/// \brief Commanded joint force
//! [forceDeclaration]
public: double jointForceCmd;
//! [forceDeclaration]

/// \brief mutex to protect jointForceCmd
public: std::mutex jointForceCmdMutex;

//! [modelDeclaration]
/// \brief Model interface
//! [modelDeclaration]
public: Model model{kNullEntity};
//! [modelDeclaration]
};
Expand Down Expand Up @@ -138,8 +138,8 @@ void ApplyJointForce::PreUpdate(const UpdateInfo &_info,
<< "s]. System may not work properly." << std::endl;
}

//! [findJoint]
// If the joint hasn't been identified yet, look for it
//! [findJoint]
if (this->dataPtr->jointEntity == kNullEntity)
{
this->dataPtr->jointEntity =
Expand All @@ -154,8 +154,8 @@ void ApplyJointForce::PreUpdate(const UpdateInfo &_info,
if (_info.paused)
return;

//! [jointForceComponent]
// Update joint force
//! [jointForceComponent]
auto force = _ecm.Component<components::JointForceCmd>(
this->dataPtr->jointEntity);
//! [jointForceComponent]
Expand Down

0 comments on commit 27198c5

Please sign in to comment.