Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
N1ghtF1re committed Nov 10, 2018
1 parent 21458bb commit e7be74b
Show file tree
Hide file tree
Showing 14 changed files with 149 additions and 31 deletions.
64 changes: 64 additions & 0 deletions docs/docspages/binarysearchtree_8c.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@
<p>File containing implementation of Binary Search Tree.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdlib.h&gt;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
<code>#include &quot;<a class="el" href="binarysearchtree_8h_source.html">binarysearchtree.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for binarysearchtree.c:</div>
Expand Down Expand Up @@ -146,6 +147,10 @@
<tr class="separator:ab7099f47a89af6ba616841096b12fe87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac41b5bd3923402036bc53b78d0132f76"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="binarysearchtree_8c.html#ac41b5bd3923402036bc53b78d0132f76">bst_removeTree</a> (<a class="el" href="struct_tree_node.html">TreeNode</a> **root)</td></tr>
<tr class="separator:ac41b5bd3923402036bc53b78d0132f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5507cc75222e5defbf2007e2867260d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="binarysearchtree_8c.html#af5507cc75222e5defbf2007e2867260d">bst_outIter</a> (<a class="el" href="struct_tree_node.html">TreeNode</a> *item, int iteration)</td></tr>
<tr class="separator:af5507cc75222e5defbf2007e2867260d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e7d7f257fa76c18aed8a427ff6ffc5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="binarysearchtree_8c.html#a0e7d7f257fa76c18aed8a427ff6ffc5e">bst_output</a> (<a class="el" href="struct_tree_node.html">TreeNode</a> *root)</td></tr>
<tr class="separator:a0e7d7f257fa76c18aed8a427ff6ffc5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File containing implementation of Binary Search Tree. </p>
Expand Down Expand Up @@ -495,6 +500,65 @@ <h2 class="memtitle"><span class="permalink"><a href="#a1a29587f335938e6bdf14d3d
</dl>
<dl class="section return"><dt>Returns</dt><dd>1(true) if key1 == key2, 0 if key1 != key2 </dd></dl>

</div>
</div>
<a id="af5507cc75222e5defbf2007e2867260d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af5507cc75222e5defbf2007e2867260d">&#9670;&nbsp;</a></span>bst_outIter()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bst_outIter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_tree_node.html">TreeNode</a> *&#160;</td>
<td class="paramname"><em>item</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>iteration</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Iteration of tree output </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">item</td><td>- Pointer to the item </td></tr>
<tr><td class="paramname">iteration</td><td>- iteration number </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="a0e7d7f257fa76c18aed8a427ff6ffc5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e7d7f257fa76c18aed8a427ff6ffc5e">&#9670;&nbsp;</a></span>bst_output()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bst_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_tree_node.html">TreeNode</a> *&#160;</td>
<td class="paramname"><em>root</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tree output </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">root</td><td>- Pointer to the root of the tree </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ae3b04d356b2d3e6ec2df334799ba8f80"></a>
Expand Down
2 changes: 2 additions & 0 deletions docs/docspages/binarysearchtree_8c.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ var binarysearchtree_8c =
[ "bst_isKeyAbove", "binarysearchtree_8c.html#a7bfafa40e180764d86db09db1d23ecbe", null ],
[ "bst_isKeyBelow", "binarysearchtree_8c.html#a7a0e58be3e6c8473b64929fb908f4bc7", null ],
[ "bst_isKeyEquals", "binarysearchtree_8c.html#a1a29587f335938e6bdf14d3da4d7394f", null ],
[ "bst_outIter", "binarysearchtree_8c.html#af5507cc75222e5defbf2007e2867260d", null ],
[ "bst_output", "binarysearchtree_8c.html#a0e7d7f257fa76c18aed8a427ff6ffc5e", null ],
[ "bst_remove", "binarysearchtree_8c.html#ae3b04d356b2d3e6ec2df334799ba8f80", null ],
[ "bst_removeByPointer", "binarysearchtree_8c.html#a355528b53f324c3563e3b82579846ccf", null ],
[ "bst_removeByPointerWithChilds", "binarysearchtree_8c.html#ab75cb87d2648fb43f5c015764f3ecc99", null ],
Expand Down
8 changes: 5 additions & 3 deletions docs/docspages/binarysearchtree_8c__incl.dot
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ digraph "src/collections/tree/binarysearchtree.c"
Node0 -> Node1 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node1 [label="stdlib.h",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node2 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node2 [label="binarysearchtree.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$binarysearchtree_8h.html",tooltip="File containing interface of Binary Search Tree. "];
Node2 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node3 [label="../node.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$node_8h.html"];
Node2 [label="stdio.h",height=0.2,width=0.4,color="grey75", fillcolor="white", style="filled"];
Node0 -> Node3 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node3 [label="binarysearchtree.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$binarysearchtree_8h.html",tooltip="File containing interface of Binary Search Tree. "];
Node3 -> Node4 [color="midnightblue",fontsize="10",style="solid",fontname="Helvetica"];
Node4 [label="../node.h",height=0.2,width=0.4,color="black", fillcolor="white", style="filled",URL="$node_8h.html"];
}
2 changes: 1 addition & 1 deletion docs/docspages/binarysearchtree_8c__incl.md5
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4e9e99d22b33bd76ed5b4f7b9acf3aea
d7ac4e48a3deeaf8569a6954357e2b15
26 changes: 26 additions & 0 deletions docs/docspages/binarysearchtree_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@
<tr class="separator:ac41b5bd3923402036bc53b78d0132f76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9113b6a3756f3e45f80f5c34eb0e0722"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="binarysearchtree_8h.html#a9113b6a3756f3e45f80f5c34eb0e0722">bst_containsKey</a> (<a class="el" href="struct_tree_node.html">TreeNode</a> *root, BstKey key)</td></tr>
<tr class="separator:a9113b6a3756f3e45f80f5c34eb0e0722"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e7d7f257fa76c18aed8a427ff6ffc5e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="binarysearchtree_8h.html#a0e7d7f257fa76c18aed8a427ff6ffc5e">bst_output</a> (<a class="el" href="struct_tree_node.html">TreeNode</a> *root)</td></tr>
<tr class="separator:a0e7d7f257fa76c18aed8a427ff6ffc5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>File containing interface of Binary Search Tree. </p>
Expand Down Expand Up @@ -356,6 +358,30 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab07c82f36288930aefb40741
</dd>
</dl>

</div>
</div>
<a id="a0e7d7f257fa76c18aed8a427ff6ffc5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e7d7f257fa76c18aed8a427ff6ffc5e">&#9670;&nbsp;</a></span>bst_output()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bst_output </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_tree_node.html">TreeNode</a> *&#160;</td>
<td class="paramname"><em>root</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tree output </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">root</td><td>- Pointer to the root of the tree </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ae3b04d356b2d3e6ec2df334799ba8f80"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/docspages/binarysearchtree_8h.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ var binarysearchtree_8h =
[ "bst_findMax", "binarysearchtree_8h.html#a9b1cce91425d96ce325634dfd7aa5c89", null ],
[ "bst_findMin", "binarysearchtree_8h.html#ae0b5c32d3df2a6f3e31fc1389682f97b", null ],
[ "bst_insert", "binarysearchtree_8h.html#ab07c82f36288930aefb40741ea68d3b7", null ],
[ "bst_output", "binarysearchtree_8h.html#a0e7d7f257fa76c18aed8a427ff6ffc5e", null ],
[ "bst_remove", "binarysearchtree_8h.html#ae3b04d356b2d3e6ec2df334799ba8f80", null ],
[ "bst_removeTree", "binarysearchtree_8h.html#ac41b5bd3923402036bc53b78d0132f76", null ],
[ "bst_removeWithChilds", "binarysearchtree_8h.html#ab7099f47a89af6ba616841096b12fe87", null ]
Expand Down
Loading

0 comments on commit e7be74b

Please sign in to comment.