Cleaning up Javadoc warnings and errors.

This commit is contained in:
Rob Greene 2018-03-10 17:36:23 -06:00
parent 3b28ad7a07
commit e1fb963913
8 changed files with 11 additions and 14 deletions

View File

@ -16,7 +16,7 @@ import com.webcodepro.shrinkit.io.LittleEndianByteInputStream;
* version, and those are documented in the getter methods.
*
* @author robgreene@users.sourceforge.net
* @see http://www.nulib.com/library/FTN.e08002.htm
* @see <a href="http://www.nulib.com/library/FTN.e08002.htm">Apple II File Type Note $E0/$8002</a>
*/
public class HeaderBlock {
private int headerCrc;

View File

@ -15,7 +15,7 @@ import com.webcodepro.shrinkit.io.LittleEndianByteInputStream;
* version, and those are documented in the getter methods.
*
* @author robgreene@users.sourceforge.net
* @see http://www.nulib.com/library/FTN.e08002.htm
* @see <a href="http://www.nulib.com/library/FTN.e08002.htm">Apple II File Type Note $E0/$8002</a>
*/
public class MasterHeaderBlock {
private static final int MASTER_HEADER_LENGTH = 48;

View File

@ -75,9 +75,8 @@ public class TimeRec {
/**
* Convert the TimeRec into a Java Date object.
* Note that years 1900-1939 are assumed to be 2000-2039 per the NuFX addendum
* at http://www.nulib.com/library/nufx-addendum.htm.
* @see http://www.nulib.com/library/nufx-addendum.htm
* Note that years 1900-1939 are assumed to be 2000-2039 per the NuFX addendum.
* @see <a href="http://www.nulib.com/library/nufx-addendum.htm">NuFX addendum</a>
*/
public Date getDate() {
int year = data[YEAR]+1900;

View File

@ -6,7 +6,7 @@ package com.webcodepro.shrinkit.io;
*
* @author robgreene@users.sourceforge.net
* @see LittleEndianByteInputStream
* @see ByteTarget
* @see LittleEndianByteOutputStream
*/
public interface ByteConstants {
/** Master Header Block identifier "magic" bytes. */

View File

@ -135,9 +135,8 @@ public class LittleEndianByteInputStream extends InputStream implements ByteCons
}
/**
* Read the TimeRec into a Java Date object.
* Note that years 00-39 are assumed to be 2000-2039 per the NuFX addendum
* at http://www.nulib.com/library/nufx-addendum.htm.
* @see http://www.nulib.com/library/nufx-addendum.htm
* Note that years 00-39 are assumed to be 2000-2039 per the NuFX addendum.
* @see <a href="http://www.nulib.com/library/nufx-addendum.htm">NuFX addendum</a>
*/
public Date readDate() throws IOException {
byte[] data = readBytes(TIMEREC_LENGTH);

View File

@ -64,9 +64,8 @@ public class LittleEndianByteOutputStream extends OutputStream implements ByteCo
}
/**
* Write the Java Date object as a TimeRec.
* Note that years 2000-2039 are assumed to be 00-39 per the NuFX addendum
* at http://www.nulib.com/library/nufx-addendum.htm.
* @see http://www.nulib.com/library/nufx-addendum.htm
* Note that years 2000-2039 are assumed to be 00-39 per the NuFX addendum.
* @see <a href="http://www.nulib.com/library/nufx-addendum.htm">NuFX addendum</a>
*/
public void writeDate(Date date) throws IOException {
byte[] data = null;

View File

@ -49,7 +49,7 @@ public class LzwInputStream extends InputStream {
* Fill the buffer up with some decompressed data.
* This may range from one byte to many bytes, depending on what is in the
* dictionary.
* @see http://en.wikipedia.org/wiki/Lzw for the general algorithm
* @see <a href="http://en.wikipedia.org/wiki/Lzw">Wikipedia for the general algorithm</a>
*/
public void fillBuffer() throws IOException {
if (dictionary == null) {

View File

@ -72,7 +72,7 @@ public class RleOutputStream extends OutputStream {
}
/**
* Close out the data stream. Makes sure the repeate buffer
* Close out the data stream. Makes sure the repeat buffer
* is flushed.
*/
public void close() throws IOException {