Add EnumData to DynamicTable Tutorials (#533)

* fix missing documentation due to gitignore * add enumerated types to dynamic table tutorial * add new enumdata doc page * test and re-export dynamic tables script * clarify dynamic tables tutorials title
NeurodataWithoutBorders · Sep 6, 2023 · 8d0e311 · 8d0e311
1 parent 68c9e12
commit 8d0e311
Show file tree

Hide file tree

Showing 10 changed files with 2,997 additions and 36 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,7 @@
-+types/
-!+types/+untyped/
-!+types/+util/
-!+types/+untyped/@DataStub
+/+types/
+!/+types/+untyped/
+!/+types/+util/
+!/+types/+untyped/@DataStub
 testResults.xml
 coverage.xml
 .ropeproject

diff --git a/doc/+types/+core/ImageReferences.html b/doc/+types/+core/ImageReferences.html
@@ -0,0 +1,192 @@
+<html>
+   <head>
+      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+
+      <link rel="stylesheet" href="../../helpwin.css">
+      <title>types.core.ImageReferences - MATLAB File Help</title>
+   </head>
+   <body>
+      <!--Single-page help-->
+      <table border="0" cellspacing="0" width="100%">
+         <tr class="subheader">
+            <td class="headertitle">types.core.ImageReferences - MATLAB File Help</td>
+
+
+
+         </tr>
+      </table>
+      <div class="title">types.core.ImageReferences</div>
+      <div class="helptext"><pre><!--helptext -->  <span class="helptopic">ImageReferences</span> Ordered dataset of references to Image objects.</pre></div><!--after help -->
+      <!--Class-->
+      <div class="sectiontitle">Class Details</div>
+      <table class="class-details">
+         <tr>
+            <td class="class-detail-label">Superclasses</td>
+            <td><a href="NWBData.html">types.core.NWBData</a>, <a href="matlab:helpwin('types.untyped.DatasetClass')">types.untyped.DatasetClass</a></td>
+         </tr>
+         <tr>
+            <td class="class-detail-label">Sealed</td>
+            <td>false</td>
+         </tr>
+         <tr>
+            <td class="class-detail-label">Construct on load</td>
+            <td>false</td>
+         </tr>
+      </table>
+      <!--Constructors-->
+      <div class="sectiontitle"><a name="constructors"></a>Constructor Summary
+      </div>
+      <table class="summary-list">
+         <tr class="summary-item">
+            <td class="name">ImageReferences</td>
+            <td class="m-help">Constructor for ImageReferences&nbsp;</td>
+         </tr>
+      </table>
+      <!--Properties-->
+      <div class="sectiontitle"><a name="properties"></a>Property Summary
+      </div>
+      <table class="summary-list">
+         <tr class="summary-item">
+            <td class="name">data</td>
+            <td class="m-help">REQUIRED any&nbsp;</td>
+         </tr>
+      </table>
+      <!--Methods-->
+      <div class="sectiontitle"><a name="methods"></a>Method Summary
+      </div>
+      <table class="summary-list">
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">addlistener</td>
+            <td class="m-help">Add listener for event.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">delete</td>
+            <td class="m-help">Delete a handle object.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">eq</td>
+            <td class="m-help">== (EQ)   Test handle equality.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">export</td>
+            <td class="m-help">&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">findobj</td>
+            <td class="m-help">Find objects matching specified conditions.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">findprop</td>
+            <td class="m-help">Find property of MATLAB handle object.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">ge</td>
+            <td class="m-help">>= (GE)   Greater than or equal relation for handles.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">gt</td>
+            <td class="m-help">> (GT)   Greater than relation for handles.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">Sealed 
+               &nbsp;
+
+            </td>
+            <td class="name">isvalid</td>
+            <td class="m-help">Test handle validity.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">le</td>
+            <td class="m-help"><= (LE)   Less than or equal relation for handles.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">listener</td>
+            <td class="m-help">Add listener for event without binding the listener to the source object.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">loadAll</td>
+            <td class="m-help">&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">lt</td>
+            <td class="m-help">< (LT)   Less than relation for handles.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">ne</td>
+            <td class="m-help">~= (NE)   Not equal relation for handles.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">notify</td>
+            <td class="m-help">Notify listeners of event.&nbsp;</td>
+         </tr>
+         <tr class="summary-item">
+            <td class="attributes">
+               &nbsp;
+
+            </td>
+            <td class="name">validate_data</td>
+            <td class="m-help">Reference to type `Image`&nbsp;</td>
+         </tr>
+      </table>
+      <!--Events-->
+      <div class="sectiontitle"><a name="events"></a>Event Summary
+      </div>
+      <table class="summary-list"></table>
+   </body>
+</html>