Skip to content

Commit

Permalink
Add doxygen group for multibody systems (#13929)
Browse files Browse the repository at this point in the history
* Add doxygen group for multibody systems

I noticed that the Propeller system was sitting in a very odd place in the doxygen hierarchy.  This cleans that up.
Also resolves a stale reference to simple_car.h
  • Loading branch information
RussTedrake authored Aug 25, 2020
1 parent 5a40341 commit 59de1fd
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
2 changes: 1 addition & 1 deletion multibody/plant/propeller.h
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ stabilizable linearization around a hovering fixed point in 3D without them).
which applies only a force (no moment) in the Propeller coordinates.
@tparam_default_scalar
@ingroup multibody
@ingroup multibody_systems
*/
template <typename T>
class Propeller final : public systems::LeafSystem<T> {
Expand Down
15 changes: 10 additions & 5 deletions systems/systems.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,10 @@
/// drake::systems::Diagram class permits modeling complex systems from
/// libraries of parts.
///
/// For a "Hello, World!" example of writing a dynamical system, see
/// simple_continuous_time_system.cc and/or simple_discrete_time_system.cc.
/// For an example of a system that uses some of the more advanced
/// features, such as typed input, output, state, and parameter vectors,
/// see simple_car.h .
/// For an introduction to using systems in python, see the dynamical_systems
/// tutorial. For a "Hello, World!" example of writing a dynamical system in
/// C++, see simple_continuous_time_system.cc and/or
/// simple_discrete_time_system.cc.
///
/// @}

Expand All @@ -30,6 +29,7 @@
/// @defgroup sensor_systems Sensors
/// @defgroup manipulation_systems Manipulation
/// @defgroup message_passing Message Passing
/// @defgroup multibody_systems Multibody Systems
/// @defgroup perception_systems Perception
/// @defgroup discrete_systems Discrete Systems
/// @defgroup stochastic_systems Stochastic Systems
Expand Down Expand Up @@ -92,6 +92,11 @@
// TODO(russt): Add pointers to / recommendations for connecting to ROS.
// TODO(russt): Add ZMQ.

/// @addtogroup multibody_systems
/// @{
/// @brief Systems that relate to, or add functionality to, MultibodyPlant.
/// @}

/// @addtogroup perception_systems
/// @{
/// @brief Systems for dealing with perception data and/or wrapping basic
Expand Down

0 comments on commit 59de1fd

Please sign in to comment.