Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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

Open
vignesh-katomaran opened this issue Aug 30, 2023 · 6 comments
Open
Labels
documentation Improve the documentation

Comments

@vignesh-katomaran
Copy link

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.

@facontidavide
Copy link
Collaborator

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?

@facontidavide facontidavide added the documentation Improve the documentation label Sep 6, 2023
@dt1729
Copy link

dt1729 commented Sep 21, 2023

I don't know who will be helped by this but these links helped me a lot in the past:
Doxygen Documentation
fkie_Behaviortree repo's wiki

@vignesh-katomaran
Copy link
Author

@facontidavide Sequence Star

@sven-hoek
Copy link

sven-hoek commented May 8, 2025

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/
ROS2 Rolling: https://docs.ros.org/en/rolling/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.

@sven-hoek
Copy link

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 doxygen Doxyfile inside to generate the documentation locally (just open doc/index.html afterwards)

@sven-hoek
Copy link

Actually, it was easier than thought, as Doxygen was already set up. PR is up: #972

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve the documentation
Projects
None yet
Development

No branches or pull requests

4 participants