From c6e813a0486998d12f6413be276c71b835e402e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20Fr=C3=B6hlich?= Date: Thu, 17 Aug 2023 14:34:55 +0200 Subject: [PATCH] Docs: Make unique headings (#341) * Make unique headings * Update docker installation * Revert "Update docker installation" This reverts commit 54ccdb618fd93730d46d85131ff0c0c49b83284a. --- example_7/doc/userdoc.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/example_7/doc/userdoc.rst b/example_7/doc/userdoc.rst index ce2a939c..0e0c905a 100644 --- a/example_7/doc/userdoc.rst +++ b/example_7/doc/userdoc.rst @@ -284,8 +284,8 @@ Finally, all ros2_control plugins should have the following two lines of code at ``PLUGINLIB_EXPORT_CLASS`` is a c++ macro creates a plugin library using ``pluginlib``. -Plugin description file -************************ +Plugin description file (hardware) +********************************** The plugin description file is a required XML file that describes a plugin's library name, class type, namespace, description, and interface type. This file allows the ROS 2 to automatically discover and load plugins. It is formatted as follows. @@ -306,8 +306,8 @@ The plugin description file is a required XML file that describes a plugin's lib The ``path`` attribute of the ``library`` tags refers to the cmake library name of the user defined hardware plugin. See `here `__ for the complete XML file. -CMake library -************* +CMake library (hardware) +************************ The general CMake template to make a hardware plugin available in ros2_control is shown below. Notice that a library is created using the plugin source code just like any other cmake library. In addition, an extra compile definition and cmake export macro (``pluginlib_export_plugin_description_file``) need to be added. See `here `__ for the complete ``CMakeLists.txt`` file. @@ -484,8 +484,8 @@ The ``on_error`` method is called if the managed node fails a state transition. } -Plugin description file -************************** +Plugin description file (controller) +************************************ The plugin description file is again required for the controller, since it is exported as a library. The controller plugin description file is formatted as follows. See `here `__ for the complete XML file. @@ -504,8 +504,8 @@ The plugin description file is again required for the controller, since it is ex -CMake library -************* +CMake library (controller) +************************** The plugin must be specified in the CMake file that builds the controller plugin. See `here `__ for the complete ``CMakeLists.txt`` file.