Update docs

JeffersonLab · Sep 20, 2024 · 9aca4e1 · 9aca4e1
1 parent b35dc8e
commit 9aca4e1
Showing 1 changed file with 15 additions and 14 deletions.
diff --git a/doc-6.0/doxygen/C/html/d9/dca/evio_8c.html b/doc-6.0/doxygen/C/html/d9/dca/evio_8c.html
@@ -102,6 +102,7 @@
 <code>#include &lt;sys/mman.h&gt;</code><br />
 <code>#include &lt;sys/types.h&gt;</code><br />
 <code>#include &lt;sys/stat.h&gt;</code><br />
+<code>#include &lt;inttypes.h&gt;</code><br />
 <code>#include &quot;<a class="el" href="../../d9/df8/evio_8h.html">evio.h</a>&quot;</code><br />
 </div><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
@@ -1652,19 +1653,19 @@ <h2 class="memtitle"><span class="permalink"><a href="#a705a578847973f904f641795
 <div class="line">    (a)[<a class="code" href="../../d9/dca/evio_8c.html#ade8b3329c5187faf18e9e4c13a2c6918">EV_HD_USERREG2</a>]      = 0; \</div>
 <div class="line">    (a)[<a class="code" href="../../d9/dca/evio_8c.html#ade8b3329c5187faf18e9e4c13a2c6918">EV_HD_USERREG2</a> + 1]  = 0; \</div>
 <div class="line">}</div>
-<div class="ttc" id="aevio_8c_html_a0cd5157d408e1aceda94cedf4a0d3ba5"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a0cd5157d408e1aceda94cedf4a0d3ba5">EV_HD_UNCOMPDATALEN</a></div><div class="ttdeci">#define EV_HD_UNCOMPDATALEN</div><div class="ttdoc">Position of blk hdr word for uncompressed data length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:595</div></div>
-<div class="ttc" id="aevio_8c_html_a1da7075dab30e934937ba33c9efd18ce"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a1da7075dab30e934937ba33c9efd18ce">EV_HD_VER</a></div><div class="ttdeci">#define EV_HD_VER</div><div class="ttdoc">Position of blk hdr word for version of file format (+ bit info in ver 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:589</div></div>
-<div class="ttc" id="aevio_8c_html_a2a6a4900e283b5c3e7c2a535654b6b49"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a2a6a4900e283b5c3e7c2a535654b6b49">EV_HD_BLKSIZ</a></div><div class="ttdeci">#define EV_HD_BLKSIZ</div><div class="ttdoc">Position of blk hdr word for size of block in 32-bit words (v 1-6).</div><div class="ttdef"><b>Definition:</b> evio.c:582</div></div>
-<div class="ttc" id="aevio_8c_html_a3fa1fcbe8a0bb506930f4241f91731fe"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a3fa1fcbe8a0bb506930f4241f91731fe">EV_HD_MAGIC</a></div><div class="ttdeci">#define EV_HD_MAGIC</div><div class="ttdoc">Position of blk hdr word for magic number for endianness tracking (v 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:591</div></div>
-<div class="ttc" id="aevio_8c_html_a42e55682880156d1a8e185616464514a"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a42e55682880156d1a8e185616464514a">EV_HD_USERHDRLEN</a></div><div class="ttdeci">#define EV_HD_USERHDRLEN</div><div class="ttdoc">Position of file &amp; blk hdr word for user header length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:594</div></div>
-<div class="ttc" id="aevio_8c_html_a5d4a7e0f93195de1a5ed500e23adf417"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a5d4a7e0f93195de1a5ed500e23adf417">EV_HD_BLKNUM</a></div><div class="ttdeci">#define EV_HD_BLKNUM</div><div class="ttdoc">Position of blk hdr word for block number, starting at 0 (v 1-6).</div><div class="ttdef"><b>Definition:</b> evio.c:583</div></div>
-<div class="ttc" id="aevio_8c_html_a6c266d0e23ed4021bab5aa7ef19f0967"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a6c266d0e23ed4021bab5aa7ef19f0967">EV_HD_INDEXARRAYLEN</a></div><div class="ttdeci">#define EV_HD_INDEXARRAYLEN</div><div class="ttdoc">Position of file &amp; blk hdr word for index array length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:593</div></div>
-<div class="ttc" id="aevio_8c_html_a79a341cd7d94bbc91df2beefd7280972"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a79a341cd7d94bbc91df2beefd7280972">EV_HD_HDSIZ</a></div><div class="ttdeci">#define EV_HD_HDSIZ</div><div class="ttdoc">Position of blk hdr word for size of header in 32-bit words (v 1-4, =8) (v 6 =14).</div><div class="ttdef"><b>Definition:</b> evio.c:584</div></div>
-<div class="ttc" id="aevio_8c_html_a7f18b9648928f04d84ca92187b77ee67"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a7f18b9648928f04d84ca92187b77ee67">EV_HD_COMPDATALEN</a></div><div class="ttdeci">#define EV_HD_COMPDATALEN</div><div class="ttdoc">Position of blk hdr word for compressed data length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:596</div></div>
-<div class="ttc" id="aevio_8c_html_a977f068f1404221ecd777db5e0805be2"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a977f068f1404221ecd777db5e0805be2">EV_HD_COUNT</a></div><div class="ttdeci">#define EV_HD_COUNT</div><div class="ttdoc">Position of blk hdr word for number of events in block (version 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:585</div></div>
-<div class="ttc" id="aevio_8c_html_aab2c0093ac862b591c7128e41d8fc27f"><div class="ttname"><a href="../../d9/dca/evio_8c.html#aab2c0093ac862b591c7128e41d8fc27f">EV_HD_USERREG1</a></div><div class="ttdeci">#define EV_HD_USERREG1</div><div class="ttdoc">Position of blk hdr word for user register 1 (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:598</div></div>
-<div class="ttc" id="aevio_8c_html_ade8b3329c5187faf18e9e4c13a2c6918"><div class="ttname"><a href="../../d9/dca/evio_8c.html#ade8b3329c5187faf18e9e4c13a2c6918">EV_HD_USERREG2</a></div><div class="ttdeci">#define EV_HD_USERREG2</div><div class="ttdoc">Position of blk hdr word for user register 2 (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:599</div></div>
-<div class="ttc" id="aevio_8c_html_af813a8152c5fa0225aa582516f9c65ba"><div class="ttname"><a href="../../d9/dca/evio_8c.html#af813a8152c5fa0225aa582516f9c65ba">EV_MAGIC</a></div><div class="ttdeci">#define EV_MAGIC</div><div class="ttdoc">Number used to determine data endian.</div><div class="ttdef"><b>Definition:</b> evio.c:117</div></div>
+<div class="ttc" id="aevio_8c_html_a0cd5157d408e1aceda94cedf4a0d3ba5"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a0cd5157d408e1aceda94cedf4a0d3ba5">EV_HD_UNCOMPDATALEN</a></div><div class="ttdeci">#define EV_HD_UNCOMPDATALEN</div><div class="ttdoc">Position of blk hdr word for uncompressed data length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:596</div></div>
+<div class="ttc" id="aevio_8c_html_a1da7075dab30e934937ba33c9efd18ce"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a1da7075dab30e934937ba33c9efd18ce">EV_HD_VER</a></div><div class="ttdeci">#define EV_HD_VER</div><div class="ttdoc">Position of blk hdr word for version of file format (+ bit info in ver 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:590</div></div>
+<div class="ttc" id="aevio_8c_html_a2a6a4900e283b5c3e7c2a535654b6b49"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a2a6a4900e283b5c3e7c2a535654b6b49">EV_HD_BLKSIZ</a></div><div class="ttdeci">#define EV_HD_BLKSIZ</div><div class="ttdoc">Position of blk hdr word for size of block in 32-bit words (v 1-6).</div><div class="ttdef"><b>Definition:</b> evio.c:583</div></div>
+<div class="ttc" id="aevio_8c_html_a3fa1fcbe8a0bb506930f4241f91731fe"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a3fa1fcbe8a0bb506930f4241f91731fe">EV_HD_MAGIC</a></div><div class="ttdeci">#define EV_HD_MAGIC</div><div class="ttdoc">Position of blk hdr word for magic number for endianness tracking (v 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:592</div></div>
+<div class="ttc" id="aevio_8c_html_a42e55682880156d1a8e185616464514a"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a42e55682880156d1a8e185616464514a">EV_HD_USERHDRLEN</a></div><div class="ttdeci">#define EV_HD_USERHDRLEN</div><div class="ttdoc">Position of file &amp; blk hdr word for user header length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:595</div></div>
+<div class="ttc" id="aevio_8c_html_a5d4a7e0f93195de1a5ed500e23adf417"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a5d4a7e0f93195de1a5ed500e23adf417">EV_HD_BLKNUM</a></div><div class="ttdeci">#define EV_HD_BLKNUM</div><div class="ttdoc">Position of blk hdr word for block number, starting at 0 (v 1-6).</div><div class="ttdef"><b>Definition:</b> evio.c:584</div></div>
+<div class="ttc" id="aevio_8c_html_a6c266d0e23ed4021bab5aa7ef19f0967"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a6c266d0e23ed4021bab5aa7ef19f0967">EV_HD_INDEXARRAYLEN</a></div><div class="ttdeci">#define EV_HD_INDEXARRAYLEN</div><div class="ttdoc">Position of file &amp; blk hdr word for index array length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:594</div></div>
+<div class="ttc" id="aevio_8c_html_a79a341cd7d94bbc91df2beefd7280972"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a79a341cd7d94bbc91df2beefd7280972">EV_HD_HDSIZ</a></div><div class="ttdeci">#define EV_HD_HDSIZ</div><div class="ttdoc">Position of blk hdr word for size of header in 32-bit words (v 1-4, =8) (v 6 =14).</div><div class="ttdef"><b>Definition:</b> evio.c:585</div></div>
+<div class="ttc" id="aevio_8c_html_a7f18b9648928f04d84ca92187b77ee67"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a7f18b9648928f04d84ca92187b77ee67">EV_HD_COMPDATALEN</a></div><div class="ttdeci">#define EV_HD_COMPDATALEN</div><div class="ttdoc">Position of blk hdr word for compressed data length (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:597</div></div>
+<div class="ttc" id="aevio_8c_html_a977f068f1404221ecd777db5e0805be2"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a977f068f1404221ecd777db5e0805be2">EV_HD_COUNT</a></div><div class="ttdeci">#define EV_HD_COUNT</div><div class="ttdoc">Position of blk hdr word for number of events in block (version 4,6).</div><div class="ttdef"><b>Definition:</b> evio.c:586</div></div>
+<div class="ttc" id="aevio_8c_html_aab2c0093ac862b591c7128e41d8fc27f"><div class="ttname"><a href="../../d9/dca/evio_8c.html#aab2c0093ac862b591c7128e41d8fc27f">EV_HD_USERREG1</a></div><div class="ttdeci">#define EV_HD_USERREG1</div><div class="ttdoc">Position of blk hdr word for user register 1 (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:599</div></div>
+<div class="ttc" id="aevio_8c_html_ade8b3329c5187faf18e9e4c13a2c6918"><div class="ttname"><a href="../../d9/dca/evio_8c.html#ade8b3329c5187faf18e9e4c13a2c6918">EV_HD_USERREG2</a></div><div class="ttdeci">#define EV_HD_USERREG2</div><div class="ttdoc">Position of blk hdr word for user register 2 (v 6).</div><div class="ttdef"><b>Definition:</b> evio.c:600</div></div>
+<div class="ttc" id="aevio_8c_html_af813a8152c5fa0225aa582516f9c65ba"><div class="ttname"><a href="../../d9/dca/evio_8c.html#af813a8152c5fa0225aa582516f9c65ba">EV_MAGIC</a></div><div class="ttdeci">#define EV_MAGIC</div><div class="ttdoc">Number used to determine data endian.</div><div class="ttdef"><b>Definition:</b> evio.c:118</div></div>
 <div class="ttc" id="aevio_8h_html_a65ca1c87412a814a49403fcf470cc973"><div class="ttname"><a href="../../d9/df8/evio_8h.html#a65ca1c87412a814a49403fcf470cc973">EV_VERSION</a></div><div class="ttdeci">#define EV_VERSION</div><div class="ttdoc">Evio format version, not the evio package version #.</div><div class="ttdef"><b>Definition:</b> evio.h:31</div></div>
 <div class="ttc" id="aevio_8h_html_ac93e9dc9080fc67db0aa3b428e681071"><div class="ttname"><a href="../../d9/df8/evio_8h.html#ac93e9dc9080fc67db0aa3b428e681071">EV_HDSIZ_V6</a></div><div class="ttdeci">#define EV_HDSIZ_V6</div><div class="ttdef"><b>Definition:</b> evio.h:36</div></div>
 </div><!-- fragment -->
@@ -1749,7 +1750,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac82dd2bbb3315a00ce8ee5b1
 <div class="line">    (a)[12]  = 0; \</div>
 <div class="line">    (a)[13]  = 0; \</div>
 <div class="line">}</div>
-<div class="ttc" id="aevio_8c_html_a9cc35e33237eb7365b9a8cf63feae450"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a9cc35e33237eb7365b9a8cf63feae450">EV_FILE_TYPE</a></div><div class="ttdeci">#define EV_FILE_TYPE</div><div class="ttdoc">In version 6, the file header's file type.</div><div class="ttdef"><b>Definition:</b> evio.c:171</div></div>
+<div class="ttc" id="aevio_8c_html_a9cc35e33237eb7365b9a8cf63feae450"><div class="ttname"><a href="../../d9/dca/evio_8c.html#a9cc35e33237eb7365b9a8cf63feae450">EV_FILE_TYPE</a></div><div class="ttdeci">#define EV_FILE_TYPE</div><div class="ttdoc">In version 6, the file header's file type.</div><div class="ttdef"><b>Definition:</b> evio.c:172</div></div>
 </div><!-- fragment -->
 <p>Initialize a file header, with split# = 1, record count = 0 (4th word). </p>