Skip to content

Commit 96ceaea

Browse files
committed
improve doxygen page
1 parent c8f92dc commit 96ceaea

File tree

1 file changed

+76
-64
lines changed

1 file changed

+76
-64
lines changed

docs/mainpage.md

Lines changed: 76 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -14,76 +14,88 @@ C++ library for behavior tree execution.
1414

1515
## Built-in Control Nodes
1616

17-
### Sequences
18-
- @ref BT::SequenceNode
19-
- @ref BT::ReactiveSequence
20-
- @ref BT::SequenceWithMemory
21-
22-
### Fallbacks
23-
- @ref BT::FallbackNode
24-
- @ref BT::ReactiveFallback
25-
26-
### Parallels
27-
- @ref BT::ParallelNode
28-
- @ref BT::ParallelAllNode
29-
30-
### Conditional
31-
- @ref BT::IfThenElseNode
32-
- @ref BT::WhileDoElseNode
33-
- @ref BT::SwitchNode
34-
- @ref BT::ManualSelectorNode
17+
<table>
18+
<tr><th>Category</th><th>Nodes</th></tr>
19+
<tr><td>Sequences</td><td><ul>
20+
<li>@ref BT::SequenceNode</li>
21+
<li>@ref BT::ReactiveSequence</li>
22+
<li>@ref BT::SequenceWithMemory</li>
23+
</ul></td></tr>
24+
<tr><td>Fallbacks</td><td><ul>
25+
<li>@ref BT::FallbackNode</li>
26+
<li>@ref BT::ReactiveFallback</li>
27+
</ul></td></tr>
28+
<tr><td>Parallels</td><td><ul>
29+
<li>@ref BT::ParallelNode</li>
30+
<li>@ref BT::ParallelAllNode</li>
31+
</ul></td></tr>
32+
<tr><td>Conditional</td><td><ul>
33+
<li>@ref BT::IfThenElseNode</li>
34+
<li>@ref BT::WhileDoElseNode</li>
35+
<li>@ref BT::SwitchNode</li>
36+
<li>@ref BT::ManualSelectorNode</li>
37+
</ul></td></tr>
38+
</table>
3539

3640
## Built-in Decorators
3741

38-
### Repetition
39-
- @ref BT::RetryNode
40-
- @ref BT::RepeatNode
41-
- @ref BT::LoopNode
42-
43-
### Timing
44-
- @ref BT::TimeoutNode
45-
- @ref BT::DelayNode
46-
47-
### Result Modification
48-
- @ref BT::InverterNode
49-
- @ref BT::ForceSuccessNode
50-
- @ref BT::ForceFailureNode
51-
52-
### Execution Control
53-
- @ref BT::RunOnceNode
54-
- @ref BT::KeepRunningUntilFailureNode
55-
56-
### Subtrees
57-
- @ref BT::SubTreeNode
58-
59-
### Preconditions
60-
- @ref BT::PreconditionNode
61-
- @ref BT::EntryUpdatedDecorator
42+
<table>
43+
<tr><th>Category</th><th>Nodes</th></tr>
44+
<tr><td>Repetition</td><td><ul>
45+
<li>@ref BT::RetryNode</li>
46+
<li>@ref BT::RepeatNode</li>
47+
<li>@ref BT::LoopNode</li>
48+
</ul></td></tr>
49+
<tr><td>Timing</td><td><ul>
50+
<li>@ref BT::TimeoutNode</li>
51+
<li>@ref BT::DelayNode</li>
52+
</ul></td></tr>
53+
<tr><td>Result Modification</td><td><ul>
54+
<li>@ref BT::InverterNode</li>
55+
<li>@ref BT::ForceSuccessNode</li>
56+
<li>@ref BT::ForceFailureNode</li>
57+
</ul></td></tr>
58+
<tr><td>Execution Control</td><td><ul>
59+
<li>@ref BT::RunOnceNode</li>
60+
<li>@ref BT::KeepRunningUntilFailureNode</li>
61+
</ul></td></tr>
62+
<tr><td>Subtrees</td><td><ul>
63+
<li>@ref BT::SubTreeNode</li>
64+
</ul></td></tr>
65+
<tr><td>Preconditions</td><td><ul>
66+
<li>@ref BT::PreconditionNode</li>
67+
<li>@ref BT::EntryUpdatedDecorator</li>
68+
</ul></td></tr>
69+
</table>
6270

6371
## Built-in Actions
6472

65-
### Status
66-
- @ref BT::AlwaysSuccessNode
67-
- @ref BT::AlwaysFailureNode
68-
69-
### Blackboard
70-
- @ref BT::SetBlackboardNode
71-
- @ref BT::UnsetBlackboardNode
72-
73-
### Utility
74-
- @ref BT::SleepNode
75-
- @ref BT::TestNode
76-
77-
### Scripting
78-
- @ref BT::ScriptNode
79-
- @ref BT::ScriptCondition
80-
81-
### Entry Updated
82-
- @ref BT::EntryUpdatedAction
83-
84-
### Queue
85-
- @ref BT::PopFromQueue
86-
- @ref BT::QueueSize
73+
<table>
74+
<tr><th>Category</th><th>Nodes</th></tr>
75+
<tr><td>Status</td><td><ul>
76+
<li>@ref BT::AlwaysSuccessNode</li>
77+
<li>@ref BT::AlwaysFailureNode</li>
78+
</ul></td></tr>
79+
<tr><td>Blackboard</td><td><ul>
80+
<li>@ref BT::SetBlackboardNode</li>
81+
<li>@ref BT::UnsetBlackboardNode</li>
82+
</ul></td></tr>
83+
<tr><td>Utility</td><td><ul>
84+
<li>@ref BT::SleepNode</li>
85+
<li>@ref BT::TestNode</li>
86+
</ul></td></tr>
87+
<tr><td>Scripting</td><td><ul>
88+
<li>@ref BT::ScriptNode</li>
89+
<li>@ref BT::ScriptCondition</li>
90+
</ul></td></tr>
91+
<tr><td>Entry Updated</td><td><ul>
92+
<li>@ref BT::EntryUpdatedAction</li>
93+
</ul></td></tr>
94+
<tr><td>Queue</td><td><ul>
95+
<li>@ref BT::PopFromQueue</li>
96+
<li>@ref BT::QueueSize</li>
97+
</ul></td></tr>
98+
</table>
8799

88100

89101
## Logging & Tools

0 commit comments

Comments
 (0)