update documentation
This commit is contained in:
1 parent
1d56a37090
commit
21d6f12163
190 files changed
+9608
-2928
No files matched your search
@@ -119,15 +119,19 @@ Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ad6ce97dcf532b452d520452b6d000daa" id="r_ad6ce97dcf532b452d520452b6d000daa"><td class="memItemLeft" align="right" valign="top"><a id="ad6ce97dcf532b452d520452b6d000daa" name="ad6ce97dcf532b452d520452b6d000daa"></a>
|
||||
<a class="el" href="classTreeNode.html">TreeNode</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classTreeNode.html">TreeNode</a> &)=delete</td></tr>
|
||||
<tr class="separator:ad6ce97dcf532b452d520452b6d000daa"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a35724af755b5d0c43de40a723ef81ec1" id="r_a35724af755b5d0c43de40a723ef81ec1"><td class="memItemLeft" align="right" valign="top"><a id="a35724af755b5d0c43de40a723ef81ec1" name="a35724af755b5d0c43de40a723ef81ec1"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>TreeNode</b> (<a class="el" href="classTreeNode.html">TreeNode</a> &&)=default</td></tr>
|
||||
<tr class="separator:a35724af755b5d0c43de40a723ef81ec1"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a88fbcbec9c64d888b19c5edb95059a95" id="r_a88fbcbec9c64d888b19c5edb95059a95"><td class="memItemLeft" align="right" valign="top"><a id="a88fbcbec9c64d888b19c5edb95059a95" name="a88fbcbec9c64d888b19c5edb95059a95"></a>
|
||||
<a class="el" href="classTreeNode.html">TreeNode</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classTreeNode.html">TreeNode</a> &&)=default</td></tr>
|
||||
<tr class="separator:a88fbcbec9c64d888b19c5edb95059a95"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad6095a87ec2bb2834041a5be0ca745fd" id="r_ad6095a87ec2bb2834041a5be0ca745fd"><td class="memItemLeft" align="right" valign="top"><a id="ad6095a87ec2bb2834041a5be0ca745fd" name="ad6095a87ec2bb2834041a5be0ca745fd"></a>
|
||||
 </td><td class="memItemRight" valign="bottom"><b>TreeNode</b> (<a class="el" href="classTreeNode.html">TreeNode</a> &&)=delete</td></tr>
|
||||
<tr class="separator:ad6095a87ec2bb2834041a5be0ca745fd"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9a3f8862ad7562e03e77b761eb94804c" id="r_a9a3f8862ad7562e03e77b761eb94804c"><td class="memItemLeft" align="right" valign="top"><a id="a9a3f8862ad7562e03e77b761eb94804c" name="a9a3f8862ad7562e03e77b761eb94804c"></a>
|
||||
<a class="el" href="classTreeNode.html">TreeNode</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classTreeNode.html">TreeNode</a> &&)=delete</td></tr>
|
||||
<tr class="separator:a9a3f8862ad7562e03e77b761eb94804c"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a6161f2ebb92184eab4215d121870e788" id="r_a6161f2ebb92184eab4215d121870e788"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#a6161f2ebb92184eab4215d121870e788">AddChild</a> (std::unique_ptr< <a class="el" href="classTreeNode.html">TreeNode</a> > child)</td></tr>
|
||||
<tr class="memdesc:a6161f2ebb92184eab4215d121870e788"><td class="mdescLeft"> </td><td class="mdescRight">Add child node. <br /></td></tr>
|
||||
<tr class="separator:a6161f2ebb92184eab4215d121870e788"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa48fbc17903eb8cfa40353e29f853c6f" id="r_aa48fbc17903eb8cfa40353e29f853c6f"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classTreeNode.html">TreeNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#aa48fbc17903eb8cfa40353e29f853c6f">GetParent</a> () const</td></tr>
|
||||
<tr class="separator:aa48fbc17903eb8cfa40353e29f853c6f"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ad501f97eeec7f7d3353bfae838fbb6a8" id="r_ad501f97eeec7f7d3353bfae838fbb6a8"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#ad501f97eeec7f7d3353bfae838fbb6a8">GetRow</a> () const</td></tr>
|
||||
<tr class="separator:ad501f97eeec7f7d3353bfae838fbb6a8"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:abdd82460187dca8d3e5d66f5d5c529ea" id="r_abdd82460187dca8d3e5d66f5d5c529ea"><td class="memItemLeft" align="right" valign="top">std::size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classTreeNode.html#abdd82460187dca8d3e5d66f5d5c529ea">GetChildCount</a> () const</td></tr>
|
||||
<tr class="memdesc:abdd82460187dca8d3e5d66f5d5c529ea"><td class="mdescLeft"> </td><td class="mdescRight">Get child count. <br /></td></tr>
|
||||
<tr class="separator:abdd82460187dca8d3e5d66f5d5c529ea"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
@@ -275,6 +279,46 @@ Public Member Functions</h2></td></tr>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00026">26</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa48fbc17903eb8cfa40353e29f853c6f" name="aa48fbc17903eb8cfa40353e29f853c6f"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa48fbc17903eb8cfa40353e29f853c6f">◆ </a></span>GetParent()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">const <a class="el" href="classTreeNode.html">TreeNode</a> * TreeNode::GetParent </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Non-owning parent; nullptr for a detached node or the root. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00068">68</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="ad501f97eeec7f7d3353bfae838fbb6a8" name="ad501f97eeec7f7d3353bfae838fbb6a8"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#ad501f97eeec7f7d3353bfae838fbb6a8">◆ </a></span>GetRow()</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">std::size_t TreeNode::GetRow </td>
|
||||
<td>(</td>
|
||||
<td class="paramname"></td><td>)</td>
|
||||
<td> const</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Zero-based sibling position; zero for a detached node or the root. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00072">72</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="abdd82460187dca8d3e5d66f5d5c529ea" name="abdd82460187dca8d3e5d66f5d5c529ea"></a>
|
||||
@@ -295,7 +339,7 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get child count. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Number of children. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00031">31</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00034">34</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -324,7 +368,7 @@ Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Child pointer or nullptr if index is invalid. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00035">35</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00038">38</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -353,7 +397,7 @@ Public Member Functions</h2></td></tr>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Child pointer or nullptr if index is invalid. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00042">42</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00045">45</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -375,7 +419,7 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get node type. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Node type. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00049">49</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00052">52</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -397,7 +441,7 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get display name. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Node name. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00053">53</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00056">56</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -419,7 +463,7 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get frame payload if node is frame. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Pointer to frame info or nullptr. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00057">57</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00060">60</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -441,7 +485,7 @@ Public Member Functions</h2></td></tr>
|
||||
<p>Get signal payload if node is signal. </p>
|
||||
<dl class="section return"><dt>Returns</dt><dd>Pointer to signal info or nullptr. </dd></dl>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00061">61</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
<p class="definition">Definition at line <a class="el" href="tree__node_8cpp_source.html#l00064">64</a> of file <a class="el" href="tree__node_8cpp_source.html">tree_node.cpp</a>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in new issue
Block a user