botaccount
/
limboai
mirror of https://github.com/limbonaut/limboai.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve class docs for BTRepeatUntil{Success,Failure}

This commit is contained in:
Serhii Snitsaruk 2023-10-09 10:37:15 +02:00
parent cb8c824314
commit eb58363977
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc_classes/BTRepeatUntilFailure.xml
View File

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeatUntilFailure" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT decorator that repeats child until [code]FAILURE[/code].
BT decorator that repeats its child task until [code]FAILURE[/code].
</brief_description>
<description>
BT decorator that repeats the child until [code]FAILURE[/code] status is returned.
Returns [code]RUNNING[/code] when the child returns [code]RUNNING[/code] or [code]SUCCESS[/code].
Returns [code]SUCCESS[/code] when the child returns [code]FAILURE[/code].
BTRepeatUntilFailure repeats its child task until it results in [code]FAILURE[/code].
Returns [code]RUNNING[/code] if the child task results in [code]RUNNING[/code] or [code]SUCCESS[/code].
Returns [code]SUCCESS[/code] if the child task results in [code]FAILURE[/code].
</description>
<tutorials>
</tutorials>

8
doc_classes/BTRepeatUntilSuccess.xml
View File

@ -1,12 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTRepeatUntilSuccess" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT decorator that repeats child until [code]SUCCESS[/code].
BT decorator that repeats its child task until [code]SUCCESS[/code].
</brief_description>
<description>
BT decorator that repeats the child until [code]SUCCESS[/code] status is returned.
Returns [code]RUNNING[/code] when the child returns [code]RUNNING[/code] or [code]FAILURE[/code].
Returns [code]SUCCESS[/code] when the child returns [code]SUCCESS[/code].
BTRepeatUntilSuccess repeats its child task until it results in [code]SUCCESS[/code].
Returns [code]RUNNING[/code] if the child task results in [code]RUNNING[/code] or [code]FAILURE[/code].
Returns [code]SUCCESS[/code] if the child task results in [code]SUCCESS[/code].
</description>
<tutorials>
</tutorials>