You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Doxygen documentation is not really accessible for most users, so it probably make sense to move documentation that want to use the plugins to another system, while keeping doxygen for people that want to check documentation of function signature or that kind of aspects.
In my opinion, a good trade-off between user friendly and low maintenance is just to write nicely written README.md for each plugin, as done for example for the gazebo_yarp_robotinterface in https://github.com/robotology/gazebo-yarp-plugins/tree/master/plugins/robotinterface, and link them from the main README. This also gives for free version selection by setting the tag in the branch/tag selector of GitHub.
The text was updated successfully, but these errors were encountered:
Doxygen documentation is not really accessible for most users, so it probably make sense to move documentation that want to use the plugins to another system, while keeping doxygen for people that want to check documentation of function signature or that kind of aspects.
In my opinion, a good trade-off between user friendly and low maintenance is just to write nicely written README.md for each plugin, as done for example for the
gazebo_yarp_robotinterface
in https://github.com/robotology/gazebo-yarp-plugins/tree/master/plugins/robotinterface, and link them from the main README. This also gives for free version selection by setting the tag in the branch/tag selector of GitHub.The text was updated successfully, but these errors were encountered: