Only released in EOL distros:
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Author: David V. Lu!!
- License: BSD
- Source: svn https://wu-robotics.googlecode.com/svn/branches/stable/wu_ros_tools
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Maintainer status: maintained
- Maintainer: David V. Lu!! <davidvlu AT gmail DOT com>
- Author: David V. Lu!!
- License: BSD
- Source: git https://github.com/DLu/wu_ros_tools.git (branch: groovy)
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Maintainer status: maintained
- Maintainer: David V. Lu!! <davidvlu AT gmail DOT com>
- Author: David V. Lu!!
- License: BSD
- Source: git https://github.com/DLu/wu_ros_tools.git (branch: hydro)
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Maintainer status: maintained
- Maintainer: David V. Lu!! <davidvlu AT gmail DOT com>
- Author: David V. Lu!!
- License: BSD
- Source: git https://github.com/DLu/wu_ros_tools.git (branch: hydro)
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Maintainer status: maintained
- Maintainer: David V. Lu!! <davidvlu AT gmail DOT com>
- Author: David V. Lu!!
- License: BSD
- Source: git https://github.com/DLu/wu_ros_tools.git (branch: hydro)
Package Summary
Creates CS/NodeAPI clearsilver documentation from source code files. Typical usage: rosrun roswiki_node roswiki src/*
- Maintainer status: maintained
- Maintainer: David V. Lu!! <davidvlu AT gmail DOT com>
- Author: David V. Lu!!
- License: BSD
- Source: git https://github.com/DLu/wu_ros_tools.git (branch: hydro)
Contents
Meta-Documentation
Let's be honest. Documentation is hard. This package is an attempt to make it easier.
Using the source code of your packages, this package applies a set of regular expressions and parses out the basic node information, particularly the type of information used by the CS/NodeAPI template, (definition here).
To generate your own documentation, run the following command.
rosrun roswiki_node roswiki [source code files]
You can list any number of source code files for a given node and the output will be code that you can paste into the ROS wiki.
Limitations
Not all of the information used by the wiki macros is parsed out. For example, if a parameter is set, the regular expression will recognize the name of the parameter being set, but not the value.
It should also be noted that this is a simple pattern matcher. No complex scope resolution is done, nor even preprocessing.
Patterns
Here are the patterns that roswiki_node currently looks for.
|
C++ |
Python |
Name |
o |
o |
Subscriptions |
o |
o |
Publications |
o |
o |
Services Used |
o |
o |
Services Called |
o |
o |
Parameters Used |
1 |
o |
Parameters Set |
o |
o |
Transforms Used |
o |
o |
Transforms Set |
x |
x |
actionlib Goals |
x |
x |
actionlib Feedback |
x |
x |
actionlib Result |
x |
x |
actionlib Actions Used |
x |
x |
1) Only parses the name of the service, not the type
Additions
Are you a regular expression whiz? Tickets and patches are welcome for adding new patterns. Submit here or contact DavidLu