boolean from the underlying input stream by
+ * Reads a {@code boolean} from the underlying input stream by
* reading a single byte. If the byte is zero, false is returned.
* If the byte is positive, true is returned.
*
- * @return the boolean value read.
+ * @return the {@code boolean} value read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -100,10 +100,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads a signed byte from the underlying input stream
+ * Reads a signed {@code byte} from the underlying input stream
* with value between -128 and 127
*
- * @return the byte value read.
+ * @return the {@code byte} value read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -118,10 +118,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads an unsigned byte from the underlying
+ * Reads an unsigned {@code byte} from the underlying
* input stream with value between 0 and 255
*
- * @return the byte value read.
+ * @return the {@code byte} value read.
* @throws EOFException if the end of the underlying input
* stream has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -135,10 +135,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads a two byte signed short from the underlying
+ * Reads a two byte signed {@code short} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the short read.
+ * @return the {@code short} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -155,7 +155,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads a two byte unsigned short from the underlying
+ * Reads a two byte unsigned {@code short} from the underlying
* input stream in little endian order, low byte first.
*
* @return the int value of the unsigned short read.
@@ -174,7 +174,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads a two byte Unicode char from the underlying
+ * Reads a two byte Unicode {@code char} from the underlying
* input stream in little endian order, low byte first.
*
* @return the int value of the unsigned short read.
@@ -193,10 +193,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
/**
- * Reads a four byte signed int from the underlying
+ * Reads a four byte signed {@code int} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the int read.
+ * @return the {@code int} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -215,10 +215,10 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * Reads an eight byte signed int from the underlying
+ * Reads an eight byte signed {@code int} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the int read.
+ * @return the {@code int} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -315,7 +315,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
/**
* @return the next eight bytes of this input stream, interpreted as a
- * little endian double.
+ * little endian {@code double}.
* @throws EOFException if end of stream occurs before eight bytes
* have been read.
* @throws IOException if an I/O error occurs.
@@ -326,7 +326,7 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
/**
* @return the next four bytes of this input stream, interpreted as a
- * little endian int.
+ * little endian {@code int}.
* @throws EOFException if end of stream occurs before four bytes
* have been read.
* @throws IOException if an I/O error occurs.
@@ -336,8 +336,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * See the general contract of the skipBytes
- * method of DataInput.
+ * See the general contract of the {@code skipBytes}
+ * method of {@code DataInput}.
*
* Bytes for this operation are read from the contained input stream.
*
@@ -359,8 +359,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * See the general contract of the readFully
- * method of DataInput.
+ * See the general contract of the {@code readFully}
+ * method of {@code DataInput}.
*
readFully
- * method of DataInput.
+ * See the general contract of the {@code readFully}
+ * method of {@code DataInput}.
*
* Bytes
* for this operation are read from the contained
@@ -407,8 +407,8 @@ public class LittleEndianDataInputStream extends FilterInputStream implements Da
}
/**
- * See the general contract of the readLine
- * method of DataInput.
+ * See the general contract of the {@code readLine}
+ * method of {@code DataInput}.
*
* Bytes for this operation are read from the contained input stream.
*
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianDataOutputStream.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianDataOutputStream.java
index 343c887c..518cf890 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianDataOutputStream.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianDataOutputStream.java
@@ -88,7 +88,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
/**
* Writes the specified byte value to the underlying output stream.
*
- * @param pByte the byte value to be written.
+ * @param pByte the {@code byte} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public synchronized void write(int pByte) throws IOException {
@@ -97,8 +97,8 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes pLength bytes from the specified byte array
- * starting at pOffset to the underlying output stream.
+ * Writes {@code pLength} bytes from the specified byte array
+ * starting at {@code pOffset} to the underlying output stream.
*
* @param pBytes the data.
* @param pOffset the start offset in the data.
@@ -113,11 +113,11 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
/**
- * Writes a boolean to the underlying output stream as
+ * Writes a {@code boolean} to the underlying output stream as
* a single byte. If the argument is true, the byte value 1 is written.
- * If the argument is false, the byte value 0 in written.
+ * If the argument is false, the byte value {@code 0} in written.
*
- * @param pBoolean the boolean value to be written.
+ * @param pBoolean the {@code boolean} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeBoolean(boolean pBoolean) throws IOException {
@@ -130,9 +130,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes out a byte to the underlying output stream
+ * Writes out a {@code byte} to the underlying output stream
*
- * @param pByte the byte value to be written.
+ * @param pByte the {@code byte} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeByte(int pByte) throws IOException {
@@ -141,10 +141,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes a two byte short to the underlying output stream in
+ * Writes a two byte {@code short} to the underlying output stream in
* little endian order, low byte first.
*
- * @param pShort the short to be written.
+ * @param pShort the {@code short} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeShort(int pShort) throws IOException {
@@ -154,10 +154,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes a two byte char to the underlying output stream
+ * Writes a two byte {@code char} to the underlying output stream
* in little endian order, low byte first.
*
- * @param pChar the char value to be written.
+ * @param pChar the {@code char} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeChar(int pChar) throws IOException {
@@ -167,10 +167,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes a four-byte int to the underlying output stream
+ * Writes a four-byte {@code int} to the underlying output stream
* in little endian order, low byte first, high byte last
*
- * @param pInt the int to be written.
+ * @param pInt the {@code int} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeInt(int pInt) throws IOException {
@@ -183,10 +183,10 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
}
/**
- * Writes an eight-byte long to the underlying output stream
+ * Writes an eight-byte {@code long} to the underlying output stream
* in little endian order, low byte first, high byte last
*
- * @param pLong the long to be written.
+ * @param pLong the {@code long} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeLong(long pLong) throws IOException {
@@ -205,7 +205,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
* Writes a 4 byte Java float to the underlying output stream in
* little endian order.
*
- * @param f the float value to be written.
+ * @param f the {@code float} value to be written.
* @throws IOException if an I/O error occurs.
*/
public final void writeFloat(float f) throws IOException {
@@ -216,7 +216,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
* Writes an 8 byte Java double to the underlying output stream in
* little endian order.
*
- * @param d the double value to be written.
+ * @param d the {@code double} value to be written.
* @throws IOException if an I/O error occurs.
*/
public final void writeDouble(double d) throws IOException {
@@ -226,9 +226,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
/**
* Writes a string to the underlying output stream as a sequence of
* bytes. Each character is written to the data output stream as
- * if by the writeByte() method.
+ * if by the {@link #writeByte(int)} method.
*
- * @param pString the String value to be written.
+ * @param pString the {@code String} value to be written.
* @throws IOException if the underlying stream throws an IOException.
* @see #writeByte(int)
* @see #out
@@ -244,9 +244,9 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
/**
* Writes a string to the underlying output stream as a sequence of
* characters. Each character is written to the data output stream as
- * if by the writeChar method.
+ * if by the {@code writeChar} method.
*
- * @param pString a String value to be written.
+ * @param pString a {@code String} value to be written.
* @throws IOException if the underlying stream throws an IOException.
* @see #writeChar(int)
* @see #out
@@ -325,7 +325,7 @@ public class LittleEndianDataOutputStream extends FilterOutputStream implements
* (This class is not thread-safe with respect to this method. It is
* possible that this number is temporarily less than the actual
* number of bytes written.)
- * @return the value of the written field.
+ * @return the value of the {@code written} field.
* @see #mWritten
*/
public int size() {
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianRandomAccessFile.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianRandomAccessFile.java
index 6a560b9c..35eb4c95 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianRandomAccessFile.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/LittleEndianRandomAccessFile.java
@@ -111,11 +111,11 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads a boolean from the underlying input stream by
+ * Reads a {@code boolean} from the underlying input stream by
* reading a single byte. If the byte is zero, false is returned.
* If the byte is positive, true is returned.
*
- * @return the boolean value read.
+ * @return the {@code boolean} value read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -129,10 +129,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads a signed byte from the underlying input stream
+ * Reads a signed {@code byte} from the underlying input stream
* with value between -128 and 127
*
- * @return the byte value read.
+ * @return the {@code byte} value read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -147,10 +147,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads an unsigned byte from the underlying
+ * Reads an unsigned {@code byte} from the underlying
* input stream with value between 0 and 255
*
- * @return the byte value read.
+ * @return the {@code byte} value read.
* @throws EOFException if the end of the underlying input
* stream has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -164,10 +164,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads a two byte signed short from the underlying
+ * Reads a two byte signed {@code short} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the short read.
+ * @return the {@code short} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -184,7 +184,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads a two byte unsigned short from the underlying
+ * Reads a two byte unsigned {@code short} from the underlying
* input stream in little endian order, low byte first.
*
* @return the int value of the unsigned short read.
@@ -203,7 +203,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads a two byte Unicode char from the underlying
+ * Reads a two byte Unicode {@code char} from the underlying
* input stream in little endian order, low byte first.
*
* @return the int value of the unsigned short read.
@@ -222,10 +222,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
/**
- * Reads a four byte signed int from the underlying
+ * Reads a four byte signed {@code int} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the int read.
+ * @return the {@code int} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -244,10 +244,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Reads an eight byte signed int from the underlying
+ * Reads an eight byte signed {@code int} from the underlying
* input stream in little endian order, low byte first.
*
- * @return the int read.
+ * @return the {@code int} read.
* @throws EOFException if the end of the underlying input stream
* has been reached
* @throws IOException if the underlying stream throws an IOException.
@@ -343,7 +343,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
/**
* @return the next eight bytes of this input stream, interpreted as a
- * little endian double.
+ * little endian {@code double}.
* @throws EOFException if end of stream occurs before eight bytes
* have been read.
* @throws IOException if an I/O error occurs.
@@ -354,7 +354,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
/**
* @return the next four bytes of this input stream, interpreted as a
- * little endian int.
+ * little endian {@code int}.
* @throws EOFException if end of stream occurs before four bytes
* have been read.
* @throws IOException if an I/O error occurs.
@@ -374,8 +374,8 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
* @param pos the offset position, measured in bytes from the
* beginning of the file, at which to set the file
* pointer.
- * @exception IOException if pos is less than
- * 0 or if an I/O error occurs.
+ * @exception IOException if {@code pos} is less than
+ * {@code 0} or if an I/O error occurs.
*/
public void seek(final long pos) throws IOException {
mFile.seek(pos);
@@ -402,11 +402,11 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes a boolean to the underlying output stream as
+ * Writes a {@code boolean} to the underlying output stream as
* a single byte. If the argument is true, the byte value 1 is written.
- * If the argument is false, the byte value 0 in written.
+ * If the argument is false, the byte value {@code 0} in written.
*
- * @param pBoolean the boolean value to be written.
+ * @param pBoolean the {@code boolean} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeBoolean(boolean pBoolean) throws IOException {
@@ -419,9 +419,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes out a byte to the underlying output stream
+ * Writes out a {@code byte} to the underlying output stream
*
- * @param pByte the byte value to be written.
+ * @param pByte the {@code byte} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeByte(int pByte) throws IOException {
@@ -429,10 +429,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes a two byte short to the underlying output stream in
+ * Writes a two byte {@code short} to the underlying output stream in
* little endian order, low byte first.
*
- * @param pShort the short to be written.
+ * @param pShort the {@code short} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeShort(int pShort) throws IOException {
@@ -441,10 +441,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes a two byte char to the underlying output stream
+ * Writes a two byte {@code char} to the underlying output stream
* in little endian order, low byte first.
*
- * @param pChar the char value to be written.
+ * @param pChar the {@code char} value to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeChar(int pChar) throws IOException {
@@ -453,10 +453,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes a four-byte int to the underlying output stream
+ * Writes a four-byte {@code int} to the underlying output stream
* in little endian order, low byte first, high byte last
*
- * @param pInt the int to be written.
+ * @param pInt the {@code int} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeInt(int pInt) throws IOException {
@@ -468,10 +468,10 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
}
/**
- * Writes an eight-byte long to the underlying output stream
+ * Writes an eight-byte {@code long} to the underlying output stream
* in little endian order, low byte first, high byte last
*
- * @param pLong the long to be written.
+ * @param pLong the {@code long} to be written.
* @throws IOException if the underlying stream throws an IOException.
*/
public void writeLong(long pLong) throws IOException {
@@ -489,7 +489,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
* Writes a 4 byte Java float to the underlying output stream in
* little endian order.
*
- * @param f the float value to be written.
+ * @param f the {@code float} value to be written.
* @throws IOException if an I/O error occurs.
*/
public final void writeFloat(float f) throws IOException {
@@ -500,7 +500,7 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
* Writes an 8 byte Java double to the underlying output stream in
* little endian order.
*
- * @param d the double value to be written.
+ * @param d the {@code double} value to be written.
* @throws IOException if an I/O error occurs.
*/
public final void writeDouble(double d) throws IOException {
@@ -510,9 +510,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
/**
* Writes a string to the underlying output stream as a sequence of
* bytes. Each character is written to the data output stream as
- * if by the writeByte() method.
+ * if by the {@code writeByte()} method.
*
- * @param pString the String value to be written.
+ * @param pString the {@code String} value to be written.
* @throws IOException if the underlying stream throws an IOException.
* @see #writeByte(int)
* @see #mFile
@@ -527,9 +527,9 @@ public class LittleEndianRandomAccessFile implements DataInput, DataOutput {
/**
* Writes a string to the underlying output stream as a sequence of
* characters. Each character is written to the data output stream as
- * if by the writeChar method.
+ * if by the {@code writeChar} method.
*
- * @param pString a String value to be written.
+ * @param pString a {@code String} value to be written.
* @throws IOException if the underlying stream throws an IOException.
* @see #writeChar(int)
* @see #mFile
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java
index 393ab6c0..872ad480 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/Win32File.java
@@ -95,17 +95,17 @@ final class Win32File extends File {
}
/**
- * Wraps a File object pointing to a Windows symbolic link
- * (.lnk file) in a Win32Lnk.
+ * Wraps a {@code File} object pointing to a Windows symbolic link
+ * ({@code .lnk} file) in a {@code Win32Lnk}.
* If the operating system is not Windows, the
- * pPath parameter is returned unwrapped.
+ * {@code pPath} parameter is returned unwrapped.
*
* @param pPath any path, possibly pointing to a Windows symbolic link file.
- * May be null, in which case null is returned.
+ * May be {@code null}, in which case {@code null} is returned.
*
- * @return a new Win32Lnk object if the current os is Windows, and
- * the file is a Windows symbolic link (.lnk file), otherwise
- * pPath
+ * @return a new {@code Win32Lnk} object if the current os is Windows, and
+ * the file is a Windows symbolic link ({@code .lnk} file), otherwise
+ * {@code pPath}
*/
public static File wrap(final File pPath) {
if (pPath == null) {
@@ -138,15 +138,15 @@ final class Win32File extends File {
}
/**
- * Wraps a File array, possibly pointing to Windows symbolic links
- * (.lnk files) in Win32Lnks.
+ * Wraps a {@code File} array, possibly pointing to Windows symbolic links
+ * ({@code .lnk} files) in {@code Win32Lnk}s.
*
- * @param pPaths an array of Files, possibly pointing to Windows
+ * @param pPaths an array of {@code File}s, possibly pointing to Windows
* symbolic link files.
- * May be null, in which case null is returned.
+ * May be {@code null}, in which case {@code null} is returned.
*
- * @return pPaths, with any File representing a Windows
- * symbolic link (.lnk file) wrapped in a Win32Lnk.
+ * @return {@code pPaths}, with any {@code File} representing a Windows
+ * symbolic link ({@code .lnk} file) wrapped in a {@code Win32Lnk}.
*/
public static File[] wrap(File[] pPaths) {
if (IS_WINDOWS) {
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/package.html
deleted file mode 100755
index a8fbf2d6..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/io/package.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
Map.Entry in Map.values(),
+ * For each {@code Map.Entry} in {@code Map.values()},
* a method named
- * set + capitalize(entry.getKey()) is called on the bean,
- * with entry.getValue() as its argument.
+ * {@code set + capitalize(entry.getKey())} is called on the bean,
+ * with {@code entry.getValue()} as its argument.
*
* Properties that has no matching set-method in the bean, are simply
* discarded.
@@ -562,10 +562,10 @@ public final class BeanUtil {
/**
* Configures the bean according to the given mapping.
- * For each Map.Entry in Map.values(),
+ * For each {@code Map.Entry} in {@code Map.values()},
* a method named
- * set + capitalize(entry.getKey()) is called on the bean,
- * with entry.getValue() as its argument.
+ * {@code set + capitalize(entry.getKey())} is called on the bean,
+ * with {@code entry.getValue()} as its argument.
*
* Optionally, lisp-style names are allowed, and automatically converted
* to Java-style camel-case names.
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/DateUtil.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/DateUtil.java
index 9f4d6987..7b9e5da3 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/DateUtil.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/DateUtil.java
@@ -98,7 +98,7 @@ public final class DateUtil {
/**
* Gets the current time, rounded down to the closest second.
* Equivalent to invoking
- * roundToSecond(System.currentTimeMillis()).
+ * {@code roundToSecond(System.currentTimeMillis())}.
*
* @return the current time, rounded to the closest second.
*/
@@ -109,7 +109,7 @@ public final class DateUtil {
/**
* Gets the current time, rounded down to the closest minute.
* Equivalent to invoking
- * roundToMinute(System.currentTimeMillis()).
+ * {@code roundToMinute(System.currentTimeMillis())}.
*
* @return the current time, rounded to the closest minute.
*/
@@ -120,7 +120,7 @@ public final class DateUtil {
/**
* Gets the current time, rounded down to the closest hour.
* Equivalent to invoking
- * roundToHour(System.currentTimeMillis()).
+ * {@code roundToHour(System.currentTimeMillis())}.
*
* @return the current time, rounded to the closest hour.
*/
@@ -131,7 +131,7 @@ public final class DateUtil {
/**
* Gets the current time, rounded down to the closest day.
* Equivalent to invoking
- * roundToDay(System.currentTimeMillis()).
+ * {@code roundToDay(System.currentTimeMillis())}.
*
* @return the current time, rounded to the closest day.
*/
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/MathUtil.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/MathUtil.java
index 02a16c49..c8a2c38e 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/MathUtil.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/MathUtil.java
@@ -51,7 +51,7 @@ public final class MathUtil {
* Java versions < 1.2 (typically for Applets).
*
* @param pAngDeg an angle, in degrees
- * @return the measurement of the angle angdeg in radians.
+ * @return the measurement of the angle {@code angdeg} in radians.
*
* @see java.lang.Math#toRadians(double)
*/
@@ -66,7 +66,7 @@ public final class MathUtil {
* Java versions < 1.2 (typically for Applets).
*
* @param pAngRad an angle, in radians
- * @return the measurement of the angle angrad in degrees.
+ * @return the measurement of the angle {@code angrad} in degrees.
*
* @see java.lang.Math#toDegrees(double)
*/
@@ -76,11 +76,11 @@ public final class MathUtil {
/**
* Returns the natural logarithm (base e) of a double value.
- * Equivalent to java.lang.Math.log, just with a proper name.
+ * Equivalent to {@code java.lang.Math.log}, just with a proper name.
*
* @param pArg a number greater than 0.0.
- * @return the value ln pArg, the natural logarithm of
- * pArg.
+ * @return the value ln {@code pArg}, the natural logarithm of
+ * {@code pArg}.
*
* @see java.lang.Math#log(double)
*/
@@ -94,8 +94,8 @@ public final class MathUtil {
* Returns the base 10 logarithm of a double value.
*
* @param pArg a number greater than 0.0.
- * @return the value log pArg, the base 10 logarithm of
- * pArg.
+ * @return the value log {@code pArg}, the base 10 logarithm of
+ * {@code pArg}.
*/
public static double log(final double pArg) {
return Math.log(pArg) / LN_10;
@@ -107,8 +107,8 @@ public final class MathUtil {
* Returns the base 2 logarithm of a double value.
*
* @param pArg a number greater than 0.0.
- * @return the value log2 pArg, the base 2
- * logarithm of pArg.
+ * @return the value log2 {@code pArg}, the base 2
+ * logarithm of {@code pArg}.
*/
public static double log2(final double pArg) {
return Math.log(pArg) / LN_2;
@@ -121,24 +121,24 @@ public final class MathUtil {
* @param pArg a number greater than 0.0.
* @param pBase a number greater than 0.0.
*
- * @return the value logpBase pArg, the base
- * pBase logarithm of pArg.
+ * @return the value logpBase {@code pArg}, the base
+ * {@code pBase} logarithm of {@code pArg}.
*/
public static double log(final double pArg, final double pBase) {
return Math.log(pArg) / Math.log(pBase);
}
/**
- * A replacement for Math.abs, that never returns negative values.
- * Math.abs(long) does this for Long.MIN_VALUE.
+ * A replacement for {@code Math.abs}, that never returns negative values.
+ * {@code Math.abs(long)} does this for {@code Long.MIN_VALUE}.
*
* @see Math#abs(long)
* @see Long#MIN_VALUE
*
* @param pNumber
- * @return the absolute value of pNumber
+ * @return the absolute value of {@code pNumber}
*
- * @throws ArithmeticException if pNumber == Long.MIN_VALUE
+ * @throws ArithmeticException if {@code pNumber == Long.MIN_VALUE}
*/
public static long abs(final long pNumber) {
if (pNumber == Long.MIN_VALUE) {
@@ -148,16 +148,16 @@ public final class MathUtil {
}
/**
- * A replacement for Math.abs, that never returns negative values.
- * Math.abs(int) does this for Integer.MIN_VALUE.
+ * A replacement for {@code Math.abs}, that never returns negative values.
+ * {@code Math.abs(int)} does this for {@code Integer.MIN_VALUE}.
*
* @see Math#abs(int)
* @see Integer#MIN_VALUE
*
* @param pNumber
- * @return the absolute value of pNumber
+ * @return the absolute value of {@code pNumber}
*
- * @throws ArithmeticException if pNumber == Integer.MIN_VALUE
+ * @throws ArithmeticException if {@code pNumber == Integer.MIN_VALUE}
*/
public static int abs(final int pNumber) {
if (pNumber == Integer.MIN_VALUE) {
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/ReflectUtil.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/ReflectUtil.java
index d414fef3..349be257 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/ReflectUtil.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/ReflectUtil.java
@@ -49,7 +49,7 @@ public final class ReflectUtil {
*
* @return the primitive type
*
- * @throws IllegalArgumentException if pType is not a primitive
+ * @throws IllegalArgumentException if {@code pType} is not a primitive
* wrapper
*/
public static Class unwrapType(Class pType) {
@@ -88,7 +88,7 @@ public final class ReflectUtil {
*
* @return the wrapper type
*
- * @throws IllegalArgumentException if pType is not a primitive
+ * @throws IllegalArgumentException if {@code pType} is not a primitive
* type
*/
public static Class wrapType(Class pType) {
@@ -121,12 +121,12 @@ public final class ReflectUtil {
}
/**
- * Returns true if the given type is a primitive wrapper.
+ * Returns {@code true} if the given type is a primitive wrapper.
*
* @param pType
*
- * @return true if the given type is a primitive wrapper, otherwise
- * false
+ * @return {@code true} if the given type is a primitive wrapper, otherwise
+ * {@code false}
*/
public static boolean isPrimitiveWrapper(Class pType) {
return pType == Boolean.class || pType == Byte.class
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package.html
deleted file mode 100755
index 01784187..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
-Contains utils/helpers for classes in {@code java.lang}.
-
-
-
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package_info.java
new file mode 100755
index 00000000..ced3971b
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/lang/package_info.java
@@ -0,0 +1,4 @@
+/**
+ *Contains utils/helpers for classes in {@code java.lang}.
+ */
+package com.twelvemonkeys.lang;
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/HttpURLConnection.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/HttpURLConnection.java
index a597a501..c0ac21ab 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/HttpURLConnection.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/HttpURLConnection.java
@@ -127,7 +127,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
* properties to be appended into a single property.
*
* @param pKey the keyword by which the request is known
- * (e.g., "accept").
+ * (e.g., "{@code accept}").
* @param pValue the value associated with it.
* @see #getRequestProperty(java.lang.String)
*/
@@ -208,7 +208,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
* Returns the name of the specified header field.
*
* @param pName the name of a header field.
- * @return the value of the named header field, or null
+ * @return the value of the named header field, or {@code null}
* if there is no such field in the header.
*/
public String getHeaderField(String pName) {
@@ -216,16 +216,16 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
}
/**
- * Returns the value for the nth header field.
- * It returns null if there are fewer than
- * n fields.
+ * Returns the value for the {@code n}th header field.
+ * It returns {@code null} if there are fewer than
+ * {@code n} fields.
*
* This method can be used in conjunction with the
- * getHeaderFieldKey method to iterate through all
+ * {@code getHeaderFieldKey} method to iterate through all
* the headers in the message.
*
* @param pIndex an index.
- * @return the value of the nth header field.
+ * @return the value of the {@code n}th header field.
* @see java.net.URLConnection#getHeaderFieldKey(int)
*/
public String getHeaderField(int pIndex) {
@@ -247,11 +247,11 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
}
/**
- * Returns the key for the nth header field.
+ * Returns the key for the {@code n}th header field.
*
* @param pIndex an index.
- * @return the key for the nth header field,
- * or null if there are fewer than n
+ * @return the key for the {@code n}th header field,
+ * or {@code null} if there are fewer than {@code n}
* fields.
*/
public String getHeaderFieldKey(int pIndex) {
@@ -641,9 +641,9 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
* Opens a communications link to the resource referenced by this
* URL, if such a connection has not already been established.
*
- * If the connect method is called when the connection
- * has already been opened (indicated by the connected
- * field having the value true), the call is ignored.
+ * If the {@code connect} method is called when the connection
+ * has already been opened (indicated by the {@code connected}
+ * field having the value {@code true}), the call is ignored.
*
* URLConnection objects go through two phases: first they are
* created, then they are connected. After being created, and
@@ -1062,7 +1062,7 @@ public class HttpURLConnection extends java.net.HttpURLConnection {
/**
* Reads the chunk size from the chunk header
- * chunk-size [SP chunk-extension] CRLF.
+ * {@code chunk-size [SP chunk-extension] CRLF}.
* The chunk-extension is simply discarded.
*
* @return the length of the current chunk, or -1 if the current chunk
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/SimpleAuthenticator.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/SimpleAuthenticator.java
index 2aeccc14..ccff833d 100755
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/SimpleAuthenticator.java
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/SimpleAuthenticator.java
@@ -37,7 +37,7 @@ import java.util.Hashtable;
/**
* A simple Authenticator implementation.
* Singleton class, obtain reference through the static
- * getInstance method.
+ * {@code getInstance} method.
*
* After swearing, sweating, pulling my hair, banging my head repeatedly
* into the walls and reading the java.net.Authenticator API documentation
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package.html
deleted file mode 100755
index b420b977..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
-Provides classes for net access.
-
-
-
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package_info.java
new file mode 100755
index 00000000..0a0322ca
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/net/package_info.java
@@ -0,0 +1,4 @@
+/**
+ * Provides classes for net access.
+ */
+package com.twelvemonkeys.net;
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge.html
deleted file mode 100755
index 7afb85e6..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-
-Provides a general purpose conversion framework, for conversion of values
-between string representations and objects.
-
-
-
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge_info.java
new file mode 100755
index 00000000..faed2215
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/convert/pacakge_info.java
@@ -0,0 +1,5 @@
+/**
+ * Provides a general purpose conversion framework, for conversion of values
+ * between string representations and objects.
+ */
+package com.twelvemonkeys.util.convert;
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package.html
deleted file mode 100755
index ca1379e6..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package.html
+++ /dev/null
@@ -1,7 +0,0 @@
-
-
-
-Provides miscellaneous utility classes.
-
-
-
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package_info.java
new file mode 100755
index 00000000..9cc218ca
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/package_info.java
@@ -0,0 +1,4 @@
+/**
+ * Provides miscellaneous utility classes.
+ */
+package com.twelvemonkeys.util;
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package.html
deleted file mode 100755
index 7b46fe76..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package.html
+++ /dev/null
@@ -1,10 +0,0 @@
-
-
-
-Provides functionality for regular expressions. This package contains a drop-in
-replacement for java.util.regex that will work on JDK1.2+.
-Plese see {@link Pattern} for more information on runtime dependencies and
-configuration.
-
-
-
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package_info.java
new file mode 100755
index 00000000..10302814
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/regex/package_info.java
@@ -0,0 +1,4 @@
+/**
+ * Provides functionality for regular expressions.
+ */
+package com.twelvemonkeys.util.regex;
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package.html b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package.html
deleted file mode 100755
index 704ccbda..00000000
--- a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package.html
+++ /dev/null
@@ -1,10 +0,0 @@
-
-
-
-Provides a service provider registry.
-
-This package contains a service provider registry, as specified in the
-JAR File Specification.
-
-
-
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package_info.java
new file mode 100755
index 00000000..ca790a2c
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/util/service/package_info.java
@@ -0,0 +1,9 @@
+/**
+ * Provides a service provider registry.
+ *
+ * This package contains a service provider registry, as specified in the
+ * JAR File Specification.
+ *
+ * @see JAR File Specification
+ */
+package com.twelvemonkeys.util.service;
diff --git a/twelvemonkeys-core/src/main/java/com/twelvemonkeys/xml/package_info.java b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/xml/package_info.java
new file mode 100644
index 00000000..5aa03c91
--- /dev/null
+++ b/twelvemonkeys-core/src/main/java/com/twelvemonkeys/xml/package_info.java
@@ -0,0 +1,4 @@
+/**
+ * Provides XML support classes.
+ */
+ package com.twelvemonkeys.xml;
\ No newline at end of file
diff --git a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/lang/ObjectAbstractTestCase.java b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/lang/ObjectAbstractTestCase.java
index a8394c63..810f446e 100755
--- a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/lang/ObjectAbstractTestCase.java
+++ b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/lang/ObjectAbstractTestCase.java
@@ -21,7 +21,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
// TODO: Create Comparable test similar way
/**
- * Creates a TestCase.
+ * Creates a {@code TestCase}.
*
* @param testName the test class name
*/
@@ -216,7 +216,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
}
/**
- * Sanity check method, makes sure that any Serializable
+ * Sanity check method, makes sure that any {@code Serializable}
* class can be serialized and de-serialized in memory,
* using the handy makeObject() method
*
@@ -306,7 +306,7 @@ public abstract class ObjectAbstractTestCase extends TestCase {
public static final class SanityTestTestCase extends ObjectAbstractTestCase {
/**
- * Creates a TestCase.
+ * Creates a {@code TestCase}.
*
*/
public SanityTestTestCase() {
diff --git a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/CollectionAbstractTestCase.java b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/CollectionAbstractTestCase.java
index 27ba846a..4bb26738 100755
--- a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/CollectionAbstractTestCase.java
+++ b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/CollectionAbstractTestCase.java
@@ -29,7 +29,7 @@ import java.util.*;
* Element Population Methods
*
* Override these if your collection restricts what kind of elements are
- * allowed (for instance, if
@@ -164,7 +164,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
/**
* Returns true if the collections produced by
* {@link #makeCollection()} and {@link #makeFullCollection()}
- * support the
* Default implementation returns true. Override if your collection
* class does not support add or addAll.
@@ -176,9 +176,9 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
/**
* Returns true if the collections produced by
* {@link #makeCollection()} and {@link #makeFullCollection()}
- * support the
* Default implementation returns true.
@@ -164,7 +164,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
/**
* Returns true if the maps produced by
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
- * support the
* Default implementation returns true.
@@ -177,7 +177,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
/**
* Returns true if the maps produced by
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
- * support the
* Default implementation returns isPutChangeSupported().
* Override if your collection class does not support setValue but does
@@ -190,7 +190,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
/**
* Returns true if the maps produced by
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
- * support the
* Default implementation returns true.
* Override if your collection class does not support removal operations.
@@ -263,7 +263,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
* method must return an array with the same length as {@link
* #getSampleValues()} and all array elements must be different. The
* default implementation constructs a set of String keys, and includes a
- * single null key if {@link #isAllowNullKey()} returns
-Some of these methods may require use of the native graphics libraries
-supported by the JVM, like the X libraries on Unix systems, and should be
-run with JRE 1.4 or later, and with the option:
-
-If you cannot use JRE 1.4 for any reason, or do not want to use the X
-libraries, a possibilty is to use the
-PJA package (com.eteks.pja),
-and start the JVM with the following options:
-
-Please note that creation of PNG images (from bytes or URL's) are only
-supported in JRE 1.3 and later, trying to load them from an earlier version,
-will result in errors.
-
-@see com.twelvemonkeys.servlet.image.ImageServlet
-@see com.twelvemonkeys.servlet.image.ImagePainterServlet
-
-
-
-
diff --git a/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/image/package_info.java b/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/image/package_info.java
new file mode 100755
index 00000000..006395c7
--- /dev/null
+++ b/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/image/package_info.java
@@ -0,0 +1,34 @@
+/**
+ * Contains various image-outputting servlets, that should run under any servlet engine. To create your own image servlet, simply subclass the servlet
+ * {@code ImageServlet}. Optionally implement the interface
+ * {@code ImagePainterServlet}, if you want to do painting.
+ *
+ * Some of these methods may require use of the native graphics libraries
+ * supported by the JVM, like the X libraries on Unix systems, and should be
+ * run with JRE 1.4 or later, and with the option:
+ *
+ * If you cannot use JRE 1.4 for any reason, or do not want to use the X
+ * libraries, a possibilty is to use the
+ * PJA package (com.eteks.pja),
+ * and start the JVM with the following options:
+ *
+ * Please note that creation of PNG images (from bytes or URL's) are only
+ * supported in JRE 1.3 and later, trying to load them from an earlier version,
+ * will result in errors.
+ *
+ * @see com.twelvemonkeys.servlet.image.ImageServlet
+ * @see com.twelvemonkeys.servlet.image.ImagePainterServlet
+ */
+package com.twelvemonkeys.servlet.image;
\ No newline at end of file
diff --git a/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/jsp/droplet/package.html b/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/jsp/droplet/package.html
deleted file mode 100755
index ae726db4..00000000
--- a/twelvemonkeys-servlet/src/main/java/com/twelvemonkeys/servlet/jsp/droplet/package.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-null is not permitted):
+ * allowed (for instance, if {@code null} is not permitted):
*
*
java.util.ArrayList, which is
+ * implementation is something like {@code java.util.ArrayList}, which is
* known to conform exactly to its collection interface's contract. After the
* operation takes place on both your collection implementation and the
* confirmed collection implementation, the two collections are compared to see
* if their state is identical. The comparison is usually much more involved
- * than a simple equals test. This verification is used to ensure
+ * than a simple {@code equals} test. This verification is used to ensure
* proper modifications are made along with ensuring that the collection does
* not change when read-only modifications are made.
* add and addAll
+ * support the {@code add} and {@code addAll}
* operations.remove, removeAll,
- * retainAll, clear and
- * iterator().remove() methods.
+ * support the {@code remove}, {@code removeAll},
+ * {@code retainAll}, {@code clear} and
+ * {@code iterator().remove()} methods.
* Default implementation returns true. Override if your collection
* class does not support removal operations.
*/
@@ -334,7 +334,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
* Returns a full collection to be used for testing. The collection
* returned by this method should contain every element returned by
* {@link #getFullElements()}. The default implementation, in fact,
- * simply invokes addAll on an empty collection with
+ * simply invokes {@code addAll} on an empty collection with
* the results of {@link #getFullElements()}. Override this default
* if your collection doesn't support addAll.
*/
@@ -1125,7 +1125,7 @@ public abstract class CollectionAbstractTestCase extends ObjectAbstractTestCase
/**
- * Tests toString on a collection.
+ * Tests {@code toString} on a collection.
*/
public void testCollectionToString() {
resetEmpty();
diff --git a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/MapAbstractTestCase.java b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/MapAbstractTestCase.java
index ff1c6ea9..d0acb17b 100755
--- a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/MapAbstractTestCase.java
+++ b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/MapAbstractTestCase.java
@@ -64,7 +64,7 @@ import java.util.*;
* collection views. Basically, the modification is performed against your
* map implementation, and an identical modification is performed against
* a confirmed map implementation. A confirmed map implementation is
- * something like java.util.HashMap, which is known to conform
+ * something like {@code java.util.HashMap}, which is known to conform
* exactly to the {@link Map} contract. After the modification takes place
* on both your map implementation and the confirmed map implementation, the
* two maps are compared to see if their state is identical. The comparison
@@ -99,7 +99,7 @@ import java.util.*;
* this base set of cases. Simply override the test case (method) your map
* fails and/or the methods that define the assumptions used by the test
* cases. For example, if your map does not allow duplicate values, override
- * {@link #isAllowDuplicateValues()} and have it return false
+ * {@link #isAllowDuplicateValues()} and have it return {@code false}
*
* @author Michael Smith
* @author Rodney Waldhoff
@@ -151,7 +151,7 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
/**
* Returns true if the maps produced by
* {@link #makeEmptyMap()} and {@link #makeFullMap()}
- * support the put and putAll operations
+ * support the {@code put} and {@code putAll} operations
* adding new mappings.
* put and putAll operations
+ * support the {@code put} and {@code putAll} operations
* changing existing mappings.
* setValue operation on entrySet entries.
+ * support the {@code setValue} operation on entrySet entries.
* remove and clear operations.
+ * support the {@code remove} and {@code clear} operations.
* true.
+ * single null key if {@link #isAllowNullKey()} returns {@code true}.
*/
public Object[] getSampleKeys() {
Object[] result = new Object[] {
@@ -305,9 +305,9 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
* method must return an array with the same length as
* {@link #getSampleKeys()}. The default implementation constructs a set of
* String values and includes a single null value if
- * {@link #isAllowNullValue()} returns true, and includes
+ * {@link #isAllowNullValue()} returns {@code true}, and includes
* two values that are the same if {@link #isAllowDuplicateValues()} returns
- * true.
+ * {@code true}.
*/
public Object[] getSampleValues() {
Object[] result = new Object[] {
@@ -327,9 +327,9 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
* returned from this method should not be the same as those returned from
* {@link #getSampleValues()}. The default implementation constructs a
* set of String values and includes a single null value if
- * {@link #isAllowNullValue()} returns true, and includes two values
+ * {@link #isAllowNullValue()} returns {@code true}, and includes two values
* that are the same if {@link #isAllowDuplicateValues()} returns
- * true.
+ * {@code true}.
*/
public Object[] getNewSampleValues() {
Object[] result = new Object[] {
@@ -1548,10 +1548,10 @@ public abstract class MapAbstractTestCase extends ObjectAbstractTestCase {
* Verifies that {@link #map} is still equal to {@link #confirmed}.
* This method checks that the map is equal to the HashMap,
* and that the map's collection views are still equal to
- * the HashMap's collection views. An equals test
+ * the HashMap's collection views. An {@code equals} test
* is done on the maps and their collection views; their size and
- * isEmpty results are compared; their hashCodes are
- * compared; and containsAll tests are run on the
+ * {@code isEmpty} results are compared; their hashCodes are
+ * compared; and {@code containsAll} tests are run on the
* collection views.
*/
public void verifyAll() {
diff --git a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/ObjectAbstractTestCase.java b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/ObjectAbstractTestCase.java
index 688acdbe..7efbc438 100755
--- a/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/ObjectAbstractTestCase.java
+++ b/twelvemonkeys-core/src/test/java/com/twelvemonkeys/util/ObjectAbstractTestCase.java
@@ -197,7 +197,7 @@ public abstract class ObjectAbstractTestCase extends MockObjectTestCase {
* Subclasses can override this variable, indicating compatibility
* with earlier Collections versions.
*
- * @return The version, or null if this object shouldn't be
+ * @return The version, or {@code null} if this object shouldn't be
* tested for compatibility with previous versions.
*/
public String getCompatibilityVersion() {
diff --git a/twelvemonkeys-core/todo.txt b/twelvemonkeys-core/todo.txt
index 4d3985c4..42ea4984 100644
--- a/twelvemonkeys-core/todo.txt
+++ b/twelvemonkeys-core/todo.txt
@@ -1,4 +1,6 @@
-- Rename core to common
+- Remove util.BASE64, make clients use io.Base64.
+
+- Rename core to common?
- Split up into three sub modules?
- common-core
- lang
diff --git a/twelvemonkeys-imageio/jmagick/src/main/java/com/twelvemonkeys/imageio/plugins/jmagick/package.html b/twelvemonkeys-imageio/jmagick/src/main/java/com/twelvemonkeys/imageio/plugins/jmagick/package.html
deleted file mode 100755
index 2eea895a..00000000
--- a/twelvemonkeys-imageio/jmagick/src/main/java/com/twelvemonkeys/imageio/plugins/jmagick/package.html
+++ /dev/null
@@ -1,13 +0,0 @@
-JMagick plugin for ImageIO that uses JMagick, an open source Java interface for
-ImageMagick to read and write images.
-ImageServlet. Optionally implement the interface
-ImagePainterServlet, if you want to do painting.
-
-
-See the document
-AWT Enhancements and bugtraq report
-4281163 for more information on this issue.
--Djawa.awt.headless=true
-
--Xbootclasspath/a:<path to pja.jar>-Dawt.toolkit=com.eteks.awt.PJAToolkit-Djava.awt.graphicsenv=com.eteks.java2d.PJAGraphicsEnvironment-Djava.awt.fonts=<path where True Type fonts files will be loaded from>
+ *
+ * See the document
+ * AWT Enhancements and bugtraq report
+ * 4281163 for more information on this issue.
+ *
+ *
+ *