Skip to content

Commit

Permalink
Minor improvement on best practice for pluginlib export (#1637)
Browse files Browse the repository at this point in the history
  • Loading branch information
shivaang12 committed Apr 16, 2020
1 parent 83054e6 commit 5a69a44
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion sphinx_doc/tutorials/docs/writing_new_costmap2d_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ In our example the ``nav2_gradient_costmap_plugin::GradientLayer`` plugin's clas
#include "pluginlib/class_list_macros.hpp"
PLUGINLIB_EXPORT_CLASS(nav2_gradient_costmap_plugin::GradientLayer, nav2_costmap_2d::Layer)
This part is usually placed at the end of cpp-file where the plugin class was written (in our example ``gradient_layer.cpp``).
This part is usually placed at the end of cpp-file where the plugin class was written (in our example ``gradient_layer.cpp``). It is good practice to place these lines at the end of the file but technically, you can also place at the top.

2. Plugin's inormation should be stored to plugin description file. This is done by using separate XML (in our example ``gradient_plugins.xml``) in the plugin's package. This file contains information about:

Expand Down

0 comments on commit 5a69a44

Please sign in to comment.