Need Complete Documentation for all BT Nodes with Examples

[vignesh-katomaran]

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]

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?

[dt1729]

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]

@facontidavide Sequence Star

[sven-hoek]

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]

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]

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