Skip to content

joss-review: updates to c++ documentation #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlizzo merged 1 commit into from
May 26, 2018
Merged

joss-review: updates to c++ documentation #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion doc/html/ComputationalGeometry_2vtkvmtkPolyDataBoundaryExtractor_8h__incl.md5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
85ab06333839cbec85854298820a2626
becc634fceca3fecd7273a94d17a2632
2 changes: 1 addition & 1 deletion doc/html/Misc_2vtkvmtkPolyDataBoundaryExtractor_8h__incl.md5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
85ab06333839cbec85854298820a2626
becc634fceca3fecd7273a94d17a2632
105 changes: 55 additions & 50 deletions doc/html/annotated.html
View file
Open in desktop

Large diffs are not rendered by default.

119 changes: 60 additions & 59 deletions doc/html/classes.html
View file
Open in desktop

Large diffs are not rendered by default.

55 changes: 26 additions & 29 deletions doc/html/classvtkvmtkActiveTubeFilter-members.html
View file
Open in desktop

Large diffs are not rendered by default.

107 changes: 15 additions & 92 deletions doc/html/classvtkvmtkActiveTubeFilter.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-static-methods">Static Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="classvtkvmtkActiveTubeFilter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">vtkvmtkActiveTubeFilter Class Reference</div> </div>
Expand All @@ -79,8 +78,18 @@
<a href="classvtkvmtkActiveTubeFilter.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="vtkvmtkActiveTubeFilter_8h_source.html">vtkvmtkActiveTubeFilter.h</a>&gt;</code></p>

<p>Inherits vtkPolyDataAlgorithm.</p>
<div class="dynheader">
Inheritance diagram for vtkvmtkActiveTubeFilter:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classvtkvmtkActiveTubeFilter__inherit__graph.svg" width="174" height="110"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for vtkvmtkActiveTubeFilter:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classvtkvmtkActiveTubeFilter__coll__graph.svg" width="174" height="110"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
Expand Down Expand Up @@ -229,15 +238,6 @@
<tr class="separator:a3cdabcc9ca8b95fa42c048506a583491"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5287c24355f1fe3fc2f915183dd9f889"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvtkvmtkActiveTubeFilter.html#a5287c24355f1fe3fc2f915183dd9f889">NegativeNormWarnings</a></td></tr>
<tr class="separator:a5287c24355f1fe3fc2f915183dd9f889"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:adb5c90669086b835ee0ca270d735f45c"><td class="memItemLeft" align="right" valign="top">virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvtkvmtkActiveTubeFilter.html#adb5c90669086b835ee0ca270d735f45c">GetClassNameInternal</a> () const</td></tr>
<tr class="separator:adb5c90669086b835ee0ca270d735f45c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2252bdf2bff9917ff0d3cefc625de76f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvtkvmtkActiveTubeFilter.html#a2252bdf2bff9917ff0d3cefc625de76f">vtkvmtkActiveTubeFilter</a> (const <a class="el" href="classvtkvmtkActiveTubeFilter.html">vtkvmtkActiveTubeFilter</a> &amp;)</td></tr>
<tr class="separator:a2252bdf2bff9917ff0d3cefc625de76f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d6aaebbe71beb21f203c40ce1ef7534"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classvtkvmtkActiveTubeFilter.html#a1d6aaebbe71beb21f203c40ce1ef7534">operator=</a> (const <a class="el" href="classvtkvmtkActiveTubeFilter.html">vtkvmtkActiveTubeFilter</a> &amp;)</td></tr>
<tr class="separator:a1d6aaebbe71beb21f203c40ce1ef7534"><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>Experimental method for generating centerlines from an image. </p>
Expand Down Expand Up @@ -265,7 +265,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9006ce4bb014d3fec8455fed
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ace9d8ca8acd0b16bb18d5fa2e6aaa095"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ace9d8ca8acd0b16bb18d5fa2e6aaa095">&#9670;&nbsp;</a></span>vtkvmtkActiveTubeFilter() <span class="overload">[1/2]</span></h2>
<h2 class="memtitle"><span class="permalink"><a href="#ace9d8ca8acd0b16bb18d5fa2e6aaa095">&#9670;&nbsp;</a></span>vtkvmtkActiveTubeFilter()</h2>

<div class="memitem">
<div class="memproto">
Expand Down Expand Up @@ -312,60 +312,9 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4f5db86bf11384cab535f0c7
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a2252bdf2bff9917ff0d3cefc625de76f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2252bdf2bff9917ff0d3cefc625de76f">&#9670;&nbsp;</a></span>vtkvmtkActiveTubeFilter() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">vtkvmtkActiveTubeFilter::vtkvmtkActiveTubeFilter </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classvtkvmtkActiveTubeFilter.html">vtkvmtkActiveTubeFilter</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="adb5c90669086b835ee0ca270d735f45c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb5c90669086b835ee0ca270d735f45c">&#9670;&nbsp;</a></span>GetClassNameInternal()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkvmtkActiveTubeFilter::GetClassNameInternal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

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

Expand Down Expand Up @@ -1553,7 +1502,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a04a02ae71b9a1cb4634728d6
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="vtkvmtkActiveTubeFilter_8h_source.html#l00101">101</a> of file <a class="el" href="vtkvmtkActiveTubeFilter_8h_source.html">vtkvmtkActiveTubeFilter.h</a>.</p>

<div class="fragment"><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160; {</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordflow">return</span> (ijk[0]&gt;=extent[0]+border &amp;&amp; ijk[0]&lt;=extent[1]-border) &amp;&amp; (ijk[1]&gt;=extent[2]+border &amp;&amp; ijk[1]&lt;=extent[3]-border) &amp;&amp; (ijk[2]&gt;=extent[4]+border &amp;&amp; ijk[2]&lt;=extent[5]-border) ? true : <span class="keyword">false</span>;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<a id="a766a68b5064f9bfbfa5fbc077d849879"></a>
Expand Down Expand Up @@ -1597,7 +1546,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a766a68b5064f9bfbfa5fbc07
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="vtkvmtkActiveTubeFilter_8h_source.html#l00106">106</a> of file <a class="el" href="vtkvmtkActiveTubeFilter_8h_source.html">vtkvmtkActiveTubeFilter.h</a>.</p>

<div class="fragment"><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; {</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">return</span> (ijk[0]&gt;=extent[0]+border &amp;&amp; ijk[0]&lt;extent[1]-border) &amp;&amp; (ijk[1]&gt;=extent[2]+border &amp;&amp; ijk[1]&lt;extent[3]-border) &amp;&amp; (ijk[2]&gt;=extent[4]+border &amp;&amp; ijk[2]&lt;extent[5]-border) ? true : <span class="keyword">false</span>;</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; }</div></div><!-- fragment -->
</div>
</div>
<a id="a103c43ca4954e2ebd78b20f40bc74877"></a>
Expand Down Expand Up @@ -1634,32 +1583,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a103c43ca4954e2ebd78b20f4
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void vtkvmtkActiveTubeFilter::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classvtkvmtkActiveTubeFilter.html">vtkvmtkActiveTubeFilter</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
Expand Down
2 changes: 2 additions & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__coll__graph.map
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="vtkvmtkActiveTubeFilter" name="vtkvmtkActiveTubeFilter">
</map>
1 change: 1 addition & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__coll__graph.md5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
9d4b637c396a2fdce439489018d710b3
28 changes: 28 additions & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__coll__graph.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__inherit__graph.map
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<map id="vtkvmtkActiveTubeFilter" name="vtkvmtkActiveTubeFilter">
</map>
1 change: 1 addition & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__inherit__graph.md5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1ea58ee78afa2e4ac6d50df1e4411956
28 changes: 28 additions & 0 deletions doc/html/classvtkvmtkActiveTubeFilter__inherit__graph.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading