Skip to content

Commit 98c03c8

Browse files
committed
documentation and doc correction
1 parent 8db5593 commit 98c03c8

File tree

2 files changed

+22
-4
lines changed

2 files changed

+22
-4
lines changed

docs/tutorial_07_multiple_xml.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ int main()
8686

8787
// Register the behavior tree definitions, but don't instantiate them, yet.
8888
// Order is not important.
89-
factory.registerBehaviorTreeFromText("main_tree.xml");
90-
factory.registerBehaviorTreeFromText("subtree_A.xml");
91-
factory.registerBehaviorTreeFromText("subtree_B.xml");
89+
factory.registerBehaviorTreeFromFile("main_tree.xml");
90+
factory.registerBehaviorTreeFromFile("subtree_A.xml");
91+
factory.registerBehaviorTreeFromFile("subtree_B.xml");
9292

9393
//Check that the BTs have been registered correctly
9494
std::cout << "Registered BehaviorTrees:" << std::endl;

include/behaviortree_cpp_v3/bt_factory.h

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,11 @@ class BehaviorTreeFactory
235235
/// Remove a registered ID.
236236
bool unregisterBuilder(const std::string& ID);
237237

238-
/// The most generic way to register your own builder.
238+
/** The most generic way to register a NodeBuilder.
239+
*
240+
* Throws if you try to register twice a builder with the same
241+
* registration_ID.
242+
*/
239243
void registerBuilder(const TreeNodeManifest& manifest, const NodeBuilder& builder);
240244

241245
template <typename T>
@@ -293,10 +297,24 @@ class BehaviorTreeFactory
293297
*/
294298
void registerFromROSPlugins();
295299

300+
/**
301+
* @brief registerBehaviorTreeFromFile.
302+
* Load the definition of an entire behavior tree, but don't instantiate it.
303+
* You can instantiate it later with:
304+
*
305+
* BehaviorTreeFactory::createTree(tree_id)
306+
*
307+
* where "tree_id" come from the XML attribute <BehaviorTree ID="tree_id">
308+
*
309+
*/
296310
void registerBehaviorTreeFromFile(const std::string& filename);
297311

312+
/// Same of registerBehaviorTreeFromFile, but passing the XML text,
313+
/// instead of the filename.
298314
void registerBehaviorTreeFromText(const std::string& xml_text);
299315

316+
/// Returns the ID of the trees registered either with
317+
/// registerBehaviorTreeFromFile or registerBehaviorTreeFromText.
300318
std::vector<std::string> registeredBehaviorTrees() const;
301319

302320
/**

0 commit comments

Comments
 (0)