-
Notifications
You must be signed in to change notification settings - Fork 721
Need Complete Documentation for all BT Nodes with Examples #649
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
The best option is to read the comments in the header files, most of the time. Any specific list of nodes I should prioritize, in your opinion? |
I don't know who will be helped by this but these links helped me a lot in the past: |
@facontidavide Sequence Star |
For anyone reaching this in search of the docs, here are links to versions of other ROS2 distros. ROS2 Humble: https://docs.ros.org/en/humble/p/behaviortree_cpp/ Not sure, which BT.CPP version each one uses or if there's a documentation build published for this lib outside the ROS context. If it doesn't exist yet, it could be well worth creating one, e.g. automatically created via GH Action and published as GH Page - especially as the website doesn't seem to list all Nodes that come with the library, which is fair enough as it seems to be a place for a handcrafted description of each node's behavior and takes time to create. If get some time to spend, I'd see how to create such a GH page from the code documentation but I don't think I will anytime soon. Edit: I should have checked the links beforehand, seems like they don't include any API documentation as in the link above, so not really helpful. |
Also, I missed that there already is a Doxyfile, so anyone who has Doxygen installed can simply clone the repo/checkout the relevant commit/branch and run |
Actually, it was easier than thought, as Doxygen was already set up. PR is up: #972 |
currently unable to find the documentation for some of the nodes also it will be better if we have complete documentation for all nodes and multiple usage examples.
The text was updated successfully, but these errors were encountered: