Skip to content

Commit

Permalink
try to make Java 9's javadoc less unhappy
Browse files Browse the repository at this point in the history
  • Loading branch information
bodewig committed Feb 8, 2020
1 parent bc2a894 commit 0fb2815
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 38 deletions.
Expand Up @@ -43,16 +43,16 @@
<p>Like any 30+-year-old application there are a number of variants.
For pragmatic reasons we will only support archives with the
'new' tape header and inode formats. Other restrictions:
</p>

<ul>
<ul>
<li>We only support ZLIB compression. The format
also permits LZO and BZLIB compression.</li>
<li>Sparse files will have the holes filled.</li>
<li>MacOS finder and resource streams are ignored.</li>
<li>Extended attributes are not currently provided.</li>
<li>SELinux labels are not currently provided.</li>
</ul>
</p>
</ul>

<p>As of Apache Commons Compress 1.3 support for the dump format is
read-only.</p>
Expand Down
Expand Up @@ -25,7 +25,8 @@
* <p>The exact type and interpretation of options depends on the
* method being configured. Currently supported are:</p>
*
* <table summary="Options">
* <table>
* <caption>Options</caption>
* <tr><th>Method</th><th>Option Type</th><th>Description</th></tr>
* <tr><td>BZIP2</td><td>Number</td><td>Block Size - an number between 1 and 9</td></tr>
* <tr><td>DEFLATE</td><td>Number</td><td>Compression Level - an number between 1 and 9</td></tr>
Expand Down
Expand Up @@ -181,7 +181,7 @@ public byte[] encode() {
* @param buf the output buffer
* @param offset
* The offset within the output buffer of the first byte to be written.
* must be non-negative and no larger than <tt>buf.length-2</tt>
* must be non-negative and no larger than {@code buf.length-2}
*/
public void encode(final byte[] buf, final int offset) {
ZipShort.putShort((dataDescriptorFlag ? DATA_DESCRIPTOR_FLAG : 0)
Expand Down
Expand Up @@ -147,7 +147,7 @@ public static byte[] getBytes(final long value) {
* @param buf the output buffer
* @param offset
* The offset within the output buffer of the first byte to be written.
* must be non-negative and no larger than <tt>buf.length-4</tt>
* must be non-negative and no larger than {@code buf.length-4}
*/

public static void putLong(final long value, final byte[] buf, int offset) {
Expand Down
Expand Up @@ -97,7 +97,7 @@ public static byte[] getBytes(final int value) {
* @param buf the output buffer
* @param offset
* The offset within the output buffer of the first byte to be written.
* must be non-negative and no larger than <tt>buf.length-2</tt>
* must be non-negative and no larger than {@code buf.length-2}
*/
public static void putShort(final int value, final byte[] buf, final int offset) {
ByteUtils.toLittleEndian(buf, value, offset, 2);
Expand Down
Expand Up @@ -65,7 +65,7 @@ public static byte[] toDosTime(final long t) {
* @param buf the output buffer
* @param offset
* The offset within the output buffer of the first byte to be written.
* must be non-negative and no larger than <tt>buf.length-4</tt>
* must be non-negative and no larger than {@code buf.length-4}
*/
public static void toDosTime(final long t, final byte[] buf, final int offset) {
toDosTime(Calendar.getInstance(), t, buf, offset);
Expand Down
Expand Up @@ -52,59 +52,60 @@
* &lt;code&gt;65k + (5 * blocksize)&lt;/code&gt;.
* </pre>
*
* <table width="100%" border="1" summary="Memory usage by blocksize">
* <table style="width:100%" border="1">
* <caption>Memory usage by blocksize</caption>
* <tr>
* <th colspan="3">Memory usage by blocksize</th>
* </tr>
* <tr>
* <th align="right">Blocksize</th> <th align="right">Compression<br>
* memory usage</th> <th align="right">Decompression<br>
* <th style="text-align: right">Blocksize</th> <th style="text-align: right">Compression<br>
* memory usage</th> <th style="text-align: right">Decompression<br>
* memory usage</th>
* </tr>
* <tr>
* <td align="right">100k</td>
* <td align="right">1300k</td>
* <td align="right">565k</td>
* <td style="text-align: right">100k</td>
* <td style="text-align: right">1300k</td>
* <td style="text-align: right">565k</td>
* </tr>
* <tr>
* <td align="right">200k</td>
* <td align="right">2200k</td>
* <td align="right">1065k</td>
* <td style="text-align: right">200k</td>
* <td style="text-align: right">2200k</td>
* <td style="text-align: right">1065k</td>
* </tr>
* <tr>
* <td align="right">300k</td>
* <td align="right">3100k</td>
* <td align="right">1565k</td>
* <td style="text-align: right">300k</td>
* <td style="text-align: right">3100k</td>
* <td style="text-align: right">1565k</td>
* </tr>
* <tr>
* <td align="right">400k</td>
* <td align="right">4000k</td>
* <td align="right">2065k</td>
* <td style="text-align: right">400k</td>
* <td style="text-align: right">4000k</td>
* <td style="text-align: right">2065k</td>
* </tr>
* <tr>
* <td align="right">500k</td>
* <td align="right">4900k</td>
* <td align="right">2565k</td>
* <td style="text-align: right">500k</td>
* <td style="text-align: right">4900k</td>
* <td style="text-align: right">2565k</td>
* </tr>
* <tr>
* <td align="right">600k</td>
* <td align="right">5800k</td>
* <td align="right">3065k</td>
* <td style="text-align: right">600k</td>
* <td style="text-align: right">5800k</td>
* <td style="text-align: right">3065k</td>
* </tr>
* <tr>
* <td align="right">700k</td>
* <td align="right">6700k</td>
* <td align="right">3565k</td>
* <td style="text-align: right">700k</td>
* <td style="text-align: right">6700k</td>
* <td style="text-align: right">3565k</td>
* </tr>
* <tr>
* <td align="right">800k</td>
* <td align="right">7600k</td>
* <td align="right">4065k</td>
* <td style="text-align: right">800k</td>
* <td style="text-align: right">7600k</td>
* <td style="text-align: right">4065k</td>
* </tr>
* <tr>
* <td align="right">900k</td>
* <td align="right">8500k</td>
* <td align="right">4565k</td>
* <td style="text-align: right">900k</td>
* <td style="text-align: right">8500k</td>
* <td style="text-align: right">4565k</td>
* </tr>
* </table>
*
Expand Down

0 comments on commit 0fb2815

Please sign in to comment.