Skip to content

Commit 000a1b7

Browse files
committed
Further refine documentation generation
1 parent 09eff35 commit 000a1b7

83 files changed

Lines changed: 389 additions & 2020 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

html/annotated.html

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -91,22 +91,17 @@
9191
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
9292
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
9393
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacemdio.html" target="_self">mdio</a></td><td class="desc"></td></tr>
94-
<tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>internal</b></td><td class="desc"></td></tr>
95-
<tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1Histogram.html" target="_self">Histogram</a></td><td class="desc">A <a class="el" href="classmdio_1_1internal_1_1Histogram.html" title="A Histogram can be either CenteredBinHistogram or EdgeDefinedHistogram as defined by the MDIO spec.">Histogram</a> can be either <a class="el" href="classmdio_1_1internal_1_1CenteredBinHistogram.html">CenteredBinHistogram</a> or <a class="el" href="classmdio_1_1internal_1_1EdgeDefinedHistogram.html">EdgeDefinedHistogram</a> as defined by the MDIO spec </td></tr>
96-
<tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1CenteredBinHistogram.html" target="_self">CenteredBinHistogram</a></td><td class="desc"></td></tr>
97-
<tr id="row_0_0_2_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1EdgeDefinedHistogram.html" target="_self">EdgeDefinedHistogram</a></td><td class="desc"></td></tr>
98-
<tr id="row_0_0_3_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1internal_1_1SummaryStats.html" target="_self">SummaryStats</a></td><td class="desc"></td></tr>
99-
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1Dataset.html" target="_self">Dataset</a></td><td class="desc">The <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class The dataset represents a collection of variables sharing a common grid </td></tr>
100-
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1UserAttributes.html" target="_self">UserAttributes</a></td><td class="desc"></td></tr>
101-
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_3_" class="arrow" onclick="toggleFolder('0_3_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable.html" target="_self">Variable</a></td><td class="desc">A templated struct representing an MDIO <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> with a tensorstore. This is an MDIO specified zarr V2 tensorstore variable. It represents the non-volitile (on-disc, in-cloud, etc.) data </td></tr>
102-
<tr id="row_0_3_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1Interval.html" target="_self">Interval</a></td><td class="desc"></td></tr>
103-
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1VariableData.html" target="_self">VariableData</a></td><td class="desc">The in-memory representation of the data This object should only be constructed through the <a class="el" href="structmdio_1_1Variable.html#af425045bbd682a466383dcb99e244c6e" title="Read the data from the variable. Reads the data from the source variable. Provide an Open method for ...">Variable::Read()</a> function. This data only exists in memory and should be preserved with the <a class="el" href="structmdio_1_1Variable.html#ab4ba4f463cf01d9b0e410ab21e590a2b" title="Write the data to the variable. Writes the data from the source variable data to the target variable.">Variable::Write()</a> function </td></tr>
104-
<tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1LabeledArray.html" target="_self">LabeledArray</a></td><td class="desc">A <a class="el" href="structmdio_1_1LabeledArray.html" title="A LabeledArray is an underlying data type for a VariableData object and is not intended to be directl...">LabeledArray</a> is an underlying data type for a <a class="el" href="structmdio_1_1VariableData.html" title="The in-memory representation of the data This object should only be constructed through the Variable:...">VariableData</a> object and is not intended to be directly interacted with </td></tr>
105-
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1RangeDescriptor.html" target="_self">RangeDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> </td></tr>
106-
<tr id="row_0_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1SliceDescriptor.html" target="_self">SliceDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a>. A struct representing how to slice a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. All slices using this will be performed as half open intervals </td></tr>
107-
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ValueDescriptor.html" target="_self">ValueDescriptor</a></td><td class="desc">A descriptor for slicing a single dimension value from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
108-
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ListDescriptor.html" target="_self">ListDescriptor</a></td><td class="desc">A descriptor for slicing a list of values from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
109-
<tr id="row_0_10_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1VariableCollection.html" target="_self">VariableCollection</a></td><td class="desc">A collection of variables. Provides type erasure for the coordinates and variables. This is intended to be an underlying data structure for the <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class </td></tr>
94+
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1Dataset.html" target="_self">Dataset</a></td><td class="desc">The <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class The dataset represents a collection of variables sharing a common grid </td></tr>
95+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1UserAttributes.html" target="_self">UserAttributes</a></td><td class="desc"></td></tr>
96+
<tr id="row_0_2_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_2_" class="arrow" onclick="toggleFolder('0_2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable.html" target="_self">Variable</a></td><td class="desc">A templated struct representing an MDIO <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> with a tensorstore. This is an MDIO specified zarr V2 tensorstore variable. It represents the non-volitile (on-disc, in-cloud, etc.) data </td></tr>
97+
<tr id="row_0_2_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1Variable_1_1Interval.html" target="_self">Interval</a></td><td class="desc"></td></tr>
98+
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1VariableData.html" target="_self">VariableData</a></td><td class="desc">The in-memory representation of the data This object should only be constructed through the <a class="el" href="structmdio_1_1Variable.html#af425045bbd682a466383dcb99e244c6e" title="Read the data from the variable. Reads the data from the source variable. Provide an Open method for ...">Variable::Read()</a> function. This data only exists in memory and should be preserved with the <a class="el" href="structmdio_1_1Variable.html#ab4ba4f463cf01d9b0e410ab21e590a2b" title="Write the data to the variable. Writes the data from the source variable data to the target variable.">Variable::Write()</a> function </td></tr>
99+
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1LabeledArray.html" target="_self">LabeledArray</a></td><td class="desc">A <a class="el" href="structmdio_1_1LabeledArray.html" title="A LabeledArray is an underlying data type for a VariableData object and is not intended to be directl...">LabeledArray</a> is an underlying data type for a <a class="el" href="structmdio_1_1VariableData.html" title="The in-memory representation of the data This object should only be constructed through the Variable:...">VariableData</a> object and is not intended to be directly interacted with </td></tr>
100+
<tr id="row_0_5_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1RangeDescriptor.html" target="_self">RangeDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> </td></tr>
101+
<tr id="row_0_6_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1SliceDescriptor.html" target="_self">SliceDescriptor</a></td><td class="desc">A descriptor for slicing a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a>. A struct representing how to slice a <a class="el" href="structmdio_1_1Variable.html" title="A templated struct representing an MDIO Variable with a tensorstore. This is an MDIO specified zarr V...">Variable</a> or <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. All slices using this will be performed as half open intervals </td></tr>
102+
<tr id="row_0_7_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ValueDescriptor.html" target="_self">ValueDescriptor</a></td><td class="desc">A descriptor for slicing a single dimension value from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
103+
<tr id="row_0_8_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structmdio_1_1ListDescriptor.html" target="_self">ListDescriptor</a></td><td class="desc">A descriptor for slicing a list of values from a <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a>. This structure is not supported for index-based slicing </td></tr>
104+
<tr id="row_0_9_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classmdio_1_1VariableCollection.html" target="_self">VariableCollection</a></td><td class="desc">A collection of variables. Provides type erasure for the coordinates and variables. This is intended to be an underlying data structure for the <a class="el" href="classmdio_1_1Dataset.html" title="The Dataset class The dataset represents a collection of variables sharing a common grid.">Dataset</a> class </td></tr>
110105
</table>
111106
</div><!-- directory -->
112107
</div><!-- contents -->

html/annotated_dup.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
var annotated_dup =
22
[
33
[ "mdio", "namespacemdio.html", [
4-
[ "internal", null, [
5-
[ "Histogram", "classmdio_1_1internal_1_1Histogram.html", "classmdio_1_1internal_1_1Histogram" ],
6-
[ "CenteredBinHistogram", "classmdio_1_1internal_1_1CenteredBinHistogram.html", "classmdio_1_1internal_1_1CenteredBinHistogram" ],
7-
[ "EdgeDefinedHistogram", "classmdio_1_1internal_1_1EdgeDefinedHistogram.html", "classmdio_1_1internal_1_1EdgeDefinedHistogram" ],
8-
[ "SummaryStats", "classmdio_1_1internal_1_1SummaryStats.html", "classmdio_1_1internal_1_1SummaryStats" ]
9-
] ],
104
[ "Dataset", "classmdio_1_1Dataset.html", "classmdio_1_1Dataset" ],
115
[ "UserAttributes", "classmdio_1_1UserAttributes.html", "classmdio_1_1UserAttributes" ],
126
[ "Variable", "structmdio_1_1Variable.html", "structmdio_1_1Variable" ],

0 commit comments

Comments
 (0)