Adds a "Message Passing" Doxygen group containing LCM systems. (Robot…

…Locomotion#6356)
Kun-Son · Jun 16, 2017 · f33e681 · f33e681
1 parent b7317a1
commit f33e681
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 4 deletions.
diff --git a/drake/doc/Doxyfile_CXX.in b/drake/doc/Doxyfile_CXX.in
@@ -112,7 +112,8 @@ WARN_LOGFILE           = "@CMAKE_CURRENT_BINARY_DIR@/doxygen_cxx.log"
 #---------------------------------------------------------------------------
 # Configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = "@drake_SOURCE_DIR@"
+INPUT                  = "@drake_SOURCE_DIR@" \
+                         "@drake_SOURCE_DIR@/../ros"
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.c \
                          *.cc \

diff --git a/drake/systems/framework/BUILD b/drake/systems/framework/BUILD
@@ -9,7 +9,6 @@ package(default_visibility = ["//visibility:public"])
 drake_cc_library(
     name = "framework",
     srcs = [],
-    hdrs = ["systems.h"],
     deps = [
         ":cache",
         ":context",

diff --git a/drake/systems/framework/CMakeLists.txt b/drake/systems/framework/CMakeLists.txt
@@ -73,7 +73,6 @@ set(installed_headers
   supervector.h
   system.h
   system_common.h
-  systems.h
   value.h
   value_checker.h
   vector_base.h

diff --git a/drake/systems/lcm/lcm_publisher_system.h b/drake/systems/lcm/lcm_publisher_system.h
@@ -17,6 +17,8 @@ namespace lcm {
 
 /**
  * Publishes an LCM message containing information from its input port.
+ *
+ * @ingroup message_passing
  */
 class LcmPublisherSystem : public LeafSystem<double> {
  public:

diff --git a/drake/systems/lcm/lcm_subscriber_system.h b/drake/systems/lcm/lcm_subscriber_system.h
@@ -35,6 +35,8 @@ namespace lcm {
  * output type. When this system is evaluated by the Simulator, all these
  * operations are taken care of by the Simulator. On the other hand, the user
  * needs to manually replicate this process without the Simulator.
+ *
+ * @ingroup message_passing
  */
 class LcmSubscriberSystem : public LeafSystem<double>,
                             public drake::lcm::DrakeLcmMessageHandlerInterface {

diff --git a/drake/systems/framework/systems.h → drake/systems/systems.h b/drake/systems/framework/systems.h → drake/systems/systems.h
@@ -13,3 +13,11 @@
 /// drake::systems::Diagram class permits modeling complex systems from
 /// libraries of parts.
 /// @}
+
+/// @defgroup message_passing Message Passing
+///
+/// These systems enable network communication.
+///
+/// @{
+/// @ingroup systems
+/// @}
diff --git a/ros/drake_ros_systems/include/drake/systems/ros_clock_publisher.h b/ros/drake_ros_systems/include/drake/systems/ros_clock_publisher.h
@@ -18,7 +18,9 @@ namespace systems {
  * network.
  *
  * For more information about ROS clock servers, see:
- * http://wiki.ros.org/Clock#Running_a_Clock_Server.
+ * http://wiki.ros.org/Clock#Running_a_Clock_Server
+ *
+ * @ingroup message_passing
  */
 class RosClockPublisher : public LeafSystem<double> {
  public:

diff --git a/ros/drake_ros_systems/include/drake/systems/ros_tf_publisher.h b/ros/drake_ros_systems/include/drake/systems/ros_tf_publisher.h
@@ -22,6 +22,8 @@ namespace systems {
  * Publishes ROS TF messages for visualizing a RigidBodyTree. It is designed to
  * take as input a RigidBodyTree's generalized state, which is typically
  * ouputted by a RigidBodyPlant.
+ *
+ * @ingroup message_passing
  */
 class RosTfPublisher : public LeafSystem<double> {
  public:
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,8 @@ namespace lcm { @@
     /**
      * Publishes an LCM message containing information from its input port.
+     *
+     * @ingroup message_passing
      */
     class LcmPublisherSystem : public LeafSystem<double> {
      public:
@@ Expand Down @@