BTRunLimit: Update class doc

This commit is contained in:
Serhii Snitsaruk 2024-02-10 20:29:48 +01:00
parent 55dfd55645
commit 3a6dc1e90c
1 changed files with 14 additions and 0 deletions

View File

@ -10,8 +10,22 @@
<tutorials>
</tutorials>
<members>
<member name="count_policy" type="int" setter="set_count_policy" getter="get_count_policy" enum="BTRunLimit.CountPolicy" default="0">
Which runs should be counted towards the limit: successful, failed, or all?
</member>
<member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1">
The maximum number of times the child is permitted to be executed.
</member>
</members>
<constants>
<constant name="COUNT_SUCCESSFUL" value="0" enum="CountPolicy">
Count only successful runs towards the limit.
</constant>
<constant name="COUNT_FAILED" value="1" enum="CountPolicy">
Count only failed runs towards the limit.
</constant>
<constant name="COUNT_ALL" value="2" enum="CountPolicy">
Count successful and failed runs towards the limit.
</constant>
</constants>
</class>