Update docs

JeffersonLab · Nov 8, 2024 · 092c481 · 092c481
1 parent d80777f
commit 092c481
Show file tree

Hide file tree

Showing 13 changed files with 788 additions and 755 deletions.
diff --git a/doc-6.0/doxygen/CC/html/d3/d87/classevio_1_1_util.html b/doc-6.0/doxygen/CC/html/d3/d87/classevio_1_1_util.html
@@ -145,9 +145,9 @@
 <tr class="memitem:a010e647b8553d03811f1c48a9908904a"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d87/classevio_1_1_util.html#a010e647b8553d03811f1c48a9908904a">printBytes</a> (std::shared_ptr&lt; <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html">ByteBuffer</a> &gt; buf, uint32_t position, uint32_t bytes, const std::string &amp;label)</td></tr>
 <tr class="memdesc:a010e647b8553d03811f1c48a9908904a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method takes a byte buffer and prints out the desired number of bytes from the given position, in hex.  <a href="../../d3/d87/classevio_1_1_util.html#a010e647b8553d03811f1c48a9908904a">More...</a><br /></td></tr>
 <tr class="separator:a010e647b8553d03811f1c48a9908904a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a25563cae3636dbc8de2fba2452e45260"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d87/classevio_1_1_util.html#a25563cae3636dbc8de2fba2452e45260">printBytes</a> (std::shared_ptr&lt; <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &gt; node, uint32_t position, uint32_t bytes, const std::string &amp;label)</td></tr>
-<tr class="memdesc:a25563cae3636dbc8de2fba2452e45260"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method takes an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> and prints out the desired number of bytes from the backing array from the given position, in hex.  <a href="../../d3/d87/classevio_1_1_util.html#a25563cae3636dbc8de2fba2452e45260">More...</a><br /></td></tr>
-<tr class="separator:a25563cae3636dbc8de2fba2452e45260"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac3f1f3596d09f90c15ec49b17964c180"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d87/classevio_1_1_util.html#ac3f1f3596d09f90c15ec49b17964c180">printBytes</a> (std::shared_ptr&lt; <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &gt; node, uint32_t bytes, const std::string &amp;label)</td></tr>
+<tr class="memdesc:ac3f1f3596d09f90c15ec49b17964c180"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method takes an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> and prints out the desired number of bytes from the backing array at the given node's position, in hex.  <a href="../../d3/d87/classevio_1_1_util.html#ac3f1f3596d09f90c15ec49b17964c180">More...</a><br /></td></tr>
+<tr class="separator:ac3f1f3596d09f90c15ec49b17964c180"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a66847f39ab5cf153f005866eb5332fce"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d87/classevio_1_1_util.html#a66847f39ab5cf153f005866eb5332fce">printBytes</a> (const <a class="el" href="../../dc/d30/classevio_1_1_byte_buffer.html">ByteBuffer</a> &amp;buf, uint32_t position, uint32_t bytes, const std::string &amp;label)</td></tr>
 <tr class="memdesc:a66847f39ab5cf153f005866eb5332fce"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method takes a byte buffer and prints out the desired number of bytes from the given position, in hex.  <a href="../../d3/d87/classevio_1_1_util.html#a66847f39ab5cf153f005866eb5332fce">More...</a><br /></td></tr>
 <tr class="separator:a66847f39ab5cf153f005866eb5332fce"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -1009,12 +1009,12 @@ <h2 class="memtitle"><span class="permalink"><a href="#a010e647b8553d03811f1c48a
   </dd>
 </dl>
 
-<p class="reference">Referenced by <a class="el" href="../../d3/d87/classevio_1_1_util.html#a25563cae3636dbc8de2fba2452e45260">printBytes()</a>, and <a class="el" href="../../df/d0c/classevio_1_1_event_writer_v4.html#a91a60f2e6b593beb1b924d441daf1b7d">evio::EventWriterV4::writeEventToFile()</a>.</p>
+<p class="reference">Referenced by <a class="el" href="../../d3/d87/classevio_1_1_util.html#ac3f1f3596d09f90c15ec49b17964c180">printBytes()</a>, and <a class="el" href="../../df/d0c/classevio_1_1_event_writer_v4.html#a91a60f2e6b593beb1b924d441daf1b7d">evio::EventWriterV4::writeEventToFile()</a>.</p>
 
 </div>
 </div>
-<a id="a25563cae3636dbc8de2fba2452e45260"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a25563cae3636dbc8de2fba2452e45260">&#9670;&nbsp;</a></span>printBytes() <span class="overload">[4/5]</span></h2>
+<a id="ac3f1f3596d09f90c15ec49b17964c180"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac3f1f3596d09f90c15ec49b17964c180">&#9670;&nbsp;</a></span>printBytes() <span class="overload">[4/5]</span></h2>
 
 <div class="memitem">
 <div class="memproto">
@@ -1028,12 +1028,6 @@ <h2 class="memtitle"><span class="permalink"><a href="#a25563cae3636dbc8de2fba24
           <td class="paramtype">std::shared_ptr&lt; <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html">EvioNode</a> &gt;&#160;</td>
           <td class="paramname"><em>node</em>, </td>
         </tr>
-        <tr>
-          <td class="paramkey"></td>
-          <td></td>
-          <td class="paramtype">uint32_t&#160;</td>
-          <td class="paramname"><em>position</em>, </td>
-        </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
@@ -1059,12 +1053,11 @@ <h2 class="memtitle"><span class="permalink"><a href="#a25563cae3636dbc8de2fba24
 </table>
 </div><div class="memdoc">
 
-<p>This method takes an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> and prints out the desired number of bytes from the backing array from the given position, in hex. </p>
+<p>This method takes an <a class="el" href="../../de/dd0/classevio_1_1_evio_node.html" title="This class is used to store relevant info about an evio container (bank, segment, or tag segment),...">EvioNode</a> and prints out the desired number of bytes from the backing array at the given node's position, in hex. </p>
 <p>Prints all bytes.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
-    <tr><td class="paramname">buf</td><td>node with backing buffer to print out </td></tr>
-    <tr><td class="paramname">position</td><td>position of data (bytes) in buffer to start printing </td></tr>
+    <tr><td class="paramname">node</td><td>node with backing buffer to print out </td></tr>
     <tr><td class="paramname">bytes</td><td>number of bytes to print in hex </td></tr>
     <tr><td class="paramname">label</td><td>a label to print as header </td></tr>
   </table>

diff --git a/doc-6.0/doxygen/CC/html/d3/d87/classevio_1_1_util.js b/doc-6.0/doxygen/CC/html/d3/d87/classevio_1_1_util.js
@@ -14,7 +14,7 @@ var classevio_1_1_util =
     [ "printBytes", "d3/d87/classevio_1_1_util.html#a66847f39ab5cf153f005866eb5332fce", null ],
     [ "printBytes", "d3/d87/classevio_1_1_util.html#af69bace572e57dd144399015a87bcaef", null ],
     [ "printBytes", "d3/d87/classevio_1_1_util.html#a010e647b8553d03811f1c48a9908904a", null ],
-    [ "printBytes", "d3/d87/classevio_1_1_util.html#a25563cae3636dbc8de2fba2452e45260", null ],
+    [ "printBytes", "d3/d87/classevio_1_1_util.html#ac3f1f3596d09f90c15ec49b17964c180", null ],
     [ "printBytes", "d3/d87/classevio_1_1_util.html#ab164e1302d6850315d45c0be6f1a8df0", null ],
     [ "readBytes", "d3/d87/classevio_1_1_util.html#a8a0fcfe01a261f79b571a12dba7faee4", null ],
     [ "stringBuilderToStrings", "d3/d87/classevio_1_1_util.html#a3533bfa3ba79b476ba13485657fb89e6", null ],

diff --git a/doc-6.0/doxygen/CC/html/d6/d36/_composite_data_8h_source.html b/doc-6.0/doxygen/CC/html/d6/d36/_composite_data_8h_source.html
@@ -781,7 +781,7 @@
 <div class="ttc" id="aclassevio_1_1_data_type_html_aa4dc041c0f0796a4b7dd12d11a9c325a"><div class="ttname"><a href="../../d5/d23/classevio_1_1_data_type.html#aa4dc041c0f0796a4b7dd12d11a9c325a">evio::DataType::USHORT16</a></div><div class="ttdeci">static const DataType USHORT16</div><div class="ttdoc">Unsigned 16 bit int.</div><div class="ttdef"><b>Definition:</b> DataType.h:41</div></div>
 <div class="ttc" id="aclassevio_1_1_data_type_html_ab594570d76a48584ae27c5e2276b3c04"><div class="ttname"><a href="../../d5/d23/classevio_1_1_data_type.html#ab594570d76a48584ae27c5e2276b3c04">evio::DataType::UINT32</a></div><div class="ttdeci">static const DataType UINT32</div><div class="ttdoc">Unsigned 32 bit int.</div><div class="ttdef"><b>Definition:</b> DataType.h:37</div></div>
 <div class="ttc" id="aclassevio_1_1_data_type_html_ae23b05542b144e3b7d72628280532195"><div class="ttname"><a href="../../d5/d23/classevio_1_1_data_type.html#ae23b05542b144e3b7d72628280532195">evio::DataType::INT32</a></div><div class="ttdeci">static const DataType INT32</div><div class="ttdoc">32 bit int.</div><div class="ttdef"><b>Definition:</b> DataType.h:47</div></div>
-<div class="ttc" id="aclassevio_1_1_util_html_a24d84643c924c770e58cc088888e16fd"><div class="ttname"><a href="../../d3/d87/classevio_1_1_util.html#a24d84643c924c770e58cc088888e16fd">evio::Util::stringsToRawSize</a></div><div class="ttdeci">static size_t stringsToRawSize(std::vector&lt; std::string &gt; const &amp;strings)</div><div class="ttdoc">This method returns the number of bytes in a raw evio format of the given string array,...</div><div class="ttdef"><b>Definition:</b> Util.h:745</div></div>
+<div class="ttc" id="aclassevio_1_1_util_html_a24d84643c924c770e58cc088888e16fd"><div class="ttname"><a href="../../d3/d87/classevio_1_1_util.html#a24d84643c924c770e58cc088888e16fd">evio::Util::stringsToRawSize</a></div><div class="ttdeci">static size_t stringsToRawSize(std::vector&lt; std::string &gt; const &amp;strings)</div><div class="ttdoc">This method returns the number of bytes in a raw evio format of the given string array,...</div><div class="ttdef"><b>Definition:</b> Util.h:742</div></div>
 <div class="ttc" id="anamespaceevio_html"><div class="ttname"><a href="../../d9/deb/namespaceevio.html">evio</a></div><div class="ttdoc">Copyright (c) 2019, Jefferson Science Associates.</div><div class="ttdef"><b>Definition:</b> BankHeader.cpp:14</div></div>
 <div class="ttc" id="aunionevio_1_1_composite_data_1_1_single_member_html"><div class="ttname"><a href="../../d3/dd7/unionevio_1_1_composite_data_1_1_single_member.html">evio::CompositeData::SingleMember</a></div><div class="ttdoc">This class holds a single, primitive type data item.</div><div class="ttdef"><b>Definition:</b> CompositeData.h:117</div></div>
 <div class="ttc" id="aunionevio_1_1_composite_data_1_1_single_member_html_a2fb71847a0713e6500e7495162048ca2"><div class="ttname"><a href="../../d3/dd7/unionevio_1_1_composite_data_1_1_single_member.html#a2fb71847a0713e6500e7495162048ca2">evio::CompositeData::SingleMember::ui32</a></div><div class="ttdeci">uint32_t ui32</div><div class="ttdoc">Unsigned int value.</div><div class="ttdef"><b>Definition:</b> CompositeData.h:132</div></div>