Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@carltimmer
carltimmer committed Aug 14, 2024
1 parent 5d6bab7 commit 01818d4
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 4 deletions.
26 changes: 26 additions & 0 deletions doc-6.0/javadoc/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,32 @@ <h2 title="org.jlab">org.jlab.*</h2>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html" title="class in org.jlab.coda.jevio">EventWriterUnsyncV4</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th scope="col">Constant Field</th>
<th class="colLast" scope="col">Value</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a name="org.jlab.coda.jevio.EventWriterUnsyncV4.DEFAULT_BLOCK_COUNT">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_COUNT">DEFAULT_BLOCK_COUNT</a></code></td>
<td class="colLast"><code>10000</code></td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a name="org.jlab.coda.jevio.EventWriterUnsyncV4.DEFAULT_BLOCK_SIZE">
<!-- -->
</a><code>public&nbsp;static&nbsp;final&nbsp;int</code></td>
<td><code><a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_SIZE">DEFAULT_BLOCK_SIZE</a></code></td>
<td class="colLast"><code>4194304</code></td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="constantsSummary" border="0" cellpadding="3" cellspacing="0" summary="Constant Field Values table, listing constant fields, and values">
<caption><span>org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/EvioBank.html" title="class in org.jlab.coda.jevio">EvioBank</a></span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
Expand Down
8 changes: 8 additions & 0 deletions doc-6.0/javadoc/index-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1040,6 +1040,14 @@ <h2 class="title">D</h2>
<dd>
<div class="block"><span class="deprecatedLabel">Deprecated.</span></div>
&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_COUNT">DEFAULT_BLOCK_COUNT</a></span> - Static variable in class org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html" title="class in org.jlab.coda.jevio">EventWriterUnsyncV4</a></dt>
<dd>
<div class="block">The default maximum event count for a single block used for writing.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_SIZE">DEFAULT_BLOCK_SIZE</a></span> - Static variable in class org.jlab.coda.jevio.<a href="org/jlab/coda/jevio/EventWriterUnsyncV4.html" title="class in org.jlab.coda.jevio">EventWriterUnsyncV4</a></dt>
<dd>
<div class="block">The default maximum size for a single block used for writing in ints or words.</div>
</dd>
</dl>
<a name="I:E">
<!-- -->
Expand Down
74 changes: 70 additions & 4 deletions doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsyncV4.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,13 @@
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
Expand Down Expand Up @@ -149,6 +149,33 @@ <h3>Nested Class Summary</h3>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_COUNT">DEFAULT_BLOCK_COUNT</a></span></code>
<div class="block">The default maximum event count for a single block used for writing.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jlab/coda/jevio/EventWriterUnsyncV4.html#DEFAULT_BLOCK_SIZE">DEFAULT_BLOCK_SIZE</a></span></code>
<div class="block">The default maximum size for a single block used for writing in ints or words.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
Expand Down Expand Up @@ -640,6 +667,45 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="DEFAULT_BLOCK_SIZE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>DEFAULT_BLOCK_SIZE</h4>
<pre>public static final&nbsp;int DEFAULT_BLOCK_SIZE</pre>
<div class="block">The default maximum size for a single block used for writing in ints or words.
This gives block sizes of 2^22 ints or 16MB.
It is a soft limit since a single
event larger than this limit may need to be written.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.jlab.coda.jevio.EventWriterUnsyncV4.DEFAULT_BLOCK_SIZE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="DEFAULT_BLOCK_COUNT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_BLOCK_COUNT</h4>
<pre>public static final&nbsp;int DEFAULT_BLOCK_COUNT</pre>
<div class="block">The default maximum event count for a single block used for writing.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#org.jlab.coda.jevio.EventWriterUnsyncV4.DEFAULT_BLOCK_COUNT">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
Expand Down Expand Up @@ -2455,13 +2521,13 @@ <h4>writeEventToFile</h4>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
Expand Down

0 comments on commit 01818d4

Please sign in to comment.