This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch pack200
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit b1bfa29ee88324a98aa5f180b04bdbb27a2fd4f4
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Jun 12 20:14:30 2021 -0400
Javadoc fixes, minimal Javadoc, and Jaavdoc TODOs.
---
.../harmony/archive/internal/nls/Messages.java | 2 ++
.../commons/compress/harmony/pack200/Archive.java | 6 ++--
.../commons/compress/harmony/pack200/BandSet.java | 36 ++++++++++++++-----
.../commons/compress/harmony/pack200/Codec.java | 3 +-
.../compress/harmony/pack200/CodecEncoding.java | 2 +-
.../harmony/pack200/MetadataBandGroup.java | 42 ++++++++++++----------
.../harmony/pack200/NewAttributeBands.java | 4 +--
.../compress/harmony/pack200/Pack200Adapter.java | 4 +--
.../compress/harmony/pack200/PackingOptions.java | 6 ++--
.../compress/harmony/pack200/PackingUtils.java | 4 +--
.../commons/compress/harmony/pack200/Segment.java | 6 +---
.../compress/harmony/unpack200/Archive.java | 5 +--
.../compress/harmony/unpack200/BandSet.java | 6 ++--
.../compress/harmony/unpack200/ClassBands.java | 8 ++---
.../compress/harmony/unpack200/IcBands.java | 2 +-
.../compress/harmony/unpack200/IcTuple.java | 1 +
.../harmony/unpack200/NewAttributeBands.java | 33 +++++++++--------
.../compress/harmony/unpack200/Segment.java | 2 ++
.../harmony/unpack200/SegmentConstantPool.java | 3 +-
.../harmony/unpack200/bytecode/CPClass.java | 2 +-
.../harmony/unpack200/bytecode/CPConstant.java | 4 +--
.../harmony/unpack200/bytecode/CPMember.java | 8 ++---
.../harmony/unpack200/bytecode/CPNameAndType.java | 4 +--
.../compress/harmony/unpack200/bytecode/CPRef.java | 6 ++--
.../harmony/unpack200/bytecode/CPString.java | 2 +-
.../harmony/unpack200/bytecode/CPUTF8.java | 2 +-
.../harmony/unpack200/bytecode/ClassFileEntry.java | 4 +--
27 files changed, 120 insertions(+), 87 deletions(-)
diff --git
a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
index b408ab4..1a99516 100644
---
a/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
+++
b/src/main/java/org/apache/commons/compress/harmony/archive/internal/nls/Messages.java
@@ -219,6 +219,8 @@ public class Messages {
*
* @param locale
* Locale the locale to change to.
+ * @param resource resource name.
+ * @return The ResourceBundle.
*/
static public ResourceBundle setLocale(final Locale locale,
final String resource) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
index 2324ad8..f47a0dd 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Archive.java
@@ -44,8 +44,8 @@ public class Archive {
/**
* Creates an Archive with streams for the input and output.
*
- * @param inputStream
- * @param outputStream
+ * @param inputStream TODO
+ * @param outputStream TODO
* @param options - packing options (if null then defaults are used)
* @throws IOException If an I/O error occurs.
*/
@@ -68,7 +68,7 @@ public class Archive {
* Creates an Archive with the given input file and a stream for the output
*
* @param jarFile - the input file
- * @param outputStream
+ * @param outputStream TODO
* @param options - packing options (if null then defaults are used)
* @throws IOException If an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
index c4a0441..3233778 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/BandSet.java
@@ -53,7 +53,7 @@ public abstract class BandSet {
/**
* Write the packed set of bands to the given output stream
- * @param out
+ * @param out TODO
* @throws IOException If an I/O error occurs.
* @throws Pack200Exception TODO
*/
@@ -570,7 +570,9 @@ public abstract class BandSet {
}
/**
- * Converts a list of Integers to an int[] array
+ * Converts a list of Integers to an int[] array.
+ * @param integerList conversion source.
+ * @return conversion result.
*/
protected int[] integerListToArray(List integerList) {
int[] array = new int[integerList.size()];
@@ -581,7 +583,9 @@ public abstract class BandSet {
}
/**
- * Converts a list of Longs to an long[] array
+ * Converts a list of Longs to an long[] array.
+ * @param longList conversion source.
+ * @return conversion result.
*/
protected long[] longListToArray(List longList) {
long[] array = new long[longList.size()];
@@ -593,6 +597,8 @@ public abstract class BandSet {
/**
* Converts a list of ConstantPoolEntrys to an int[] array of their indices
+ * @param list conversion source.
+ * @return conversion result.
*/
protected int[] cpEntryListToArray(List list) {
int[] array = new int[list.size()];
@@ -608,6 +614,8 @@ public abstract class BandSet {
/**
* Converts a list of ConstantPoolEntrys or nulls to an int[] array of
their
* indices +1 (or 0 for nulls)
+ * @param theList conversion source.
+ * @return conversion result.
*/
protected int[] cpEntryOrNullListToArray(List theList) {
int[] array = new int[theList.size()];
@@ -718,7 +726,10 @@ public abstract class BandSet {
/**
* Returns true if the deltas between adjacent band elements are mainly
- * small (heuristic)
+ * small (heuristic).
+ *
+ * @return true if the deltas between adjacent band elements are mainly
+ * small (heuristic).
*/
public boolean mainlySmallDeltas() {
// Note: the value below has been tuned - please test carefully if
changing it
@@ -727,7 +738,10 @@ public abstract class BandSet {
/**
* Returns true if the band is well correlated (i.e. would be suitable
- * for a delta encoding) (heuristic)
+ * for a delta encoding) (heuristic).
+ *
+ * @return true if the band is well correlated (i.e. would be suitable
+ * for a delta encoding) (heuristic).
*/
public boolean wellCorrelated() {
// Note: the value below has been tuned - please test carefully if
changing it
@@ -735,7 +749,9 @@ public abstract class BandSet {
}
/**
- * Returns true if the band deltas are mainly positive (heuristic)
+ * Returns true if the band deltas are mainly positive (heuristic).
+ *
+ * @return true if the band deltas are mainly positive (heuristic).
*/
public boolean mainlyPositiveDeltas() {
// Note: the value below has been tuned - please test carefully if
changing it
@@ -743,14 +759,18 @@ public abstract class BandSet {
}
/**
- * Returns true if any band elements are negative
+ * Returns true if any band elements are negative.
+ *
+ * @return true if any band elements are negative.
*/
public boolean anyNegatives() {
return smallest < 0;
}
/**
- * Returns the total number of distinct values found in the band
+ * Returns the total number of distinct values found in the band.
+ *
+ * @return the total number of distinct values found in the band.
*/
public int numDistinctValues() {
if(distinctValues == null) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
index 52a02aa..eb2b9b0 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Codec.java
@@ -162,8 +162,7 @@ public abstract class Codec {
/**
* Decodes a sequence of <code>n</code> values from <code>in</code>.
* This should probably be used in most cases, since some codecs (such as
- *
- * @{link PopCodec}) only work when the number of values to be read is
+ * {@link PopulationCodec}) only work when the number of values to be read
is
* known.
*
* @param n
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java
index 5769ae0..20def84 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/CodecEncoding.java
@@ -99,7 +99,7 @@ public class CodecEncoding {
/**
* Returns the codec specified by the given value byte and optional byte
- * header. If the value is >=116, then bytes may be consumed from the
+ * header. If the value is >= 116, then bytes may be consumed from the
* secondary input stream, which is taken to be the contents of the
* band_headers byte array. Since the values from this are consumed and not
* repeated, the input stream should be reused for subsequent encodings.
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
index ee24d59..9ea5a88 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/MetadataBandGroup.java
@@ -241,16 +241,18 @@ public class MetadataBandGroup extends BandSet {
}
/**
- * Add an annotation to this set of bands
- *
- * @param desc
- * @param nameRU
- * @param t
- * @param values
- * @param caseArrayN
- * @param nestTypeRS
- * @param nestNameRU
- * @param nestPairN
+ * Add an annotation to this set of bands.
+ * @param numParams TODO
+ * @param annoN TODO
+ * @param pairN TODO
+ * @param typeRS TODO
+ * @param nameRU TODO
+ * @param t TODO
+ * @param values TODO
+ * @param caseArrayN TODO
+ * @param nestTypeRS TODO
+ * @param nestNameRU TODO
+ * @param nestPairN TODO
*/
public void addParameterAnnotation(int numParams, int[] annoN, IntList
pairN, List typeRS, List nameRU, List t, List values, List caseArrayN, List
nestTypeRS, List nestNameRU, List nestPairN) {
param_NB.add(numParams);
@@ -320,14 +322,14 @@ public class MetadataBandGroup extends BandSet {
/**
* Add an annotation to this set of bands
*
- * @param desc
- * @param nameRU
- * @param t
- * @param values
- * @param caseArrayN
- * @param nestTypeRS
- * @param nestNameRU
- * @param nestPairN
+ * @param desc TODO
+ * @param nameRU TODO
+ * @param t TODO
+ * @param values TODO
+ * @param caseArrayN TODO
+ * @param nestTypeRS TODO
+ * @param nestNameRU TODO
+ * @param nestPairN TODO
*/
public void addAnnotation(String desc, List nameRU, List t, List values,
List caseArrayN, List nestTypeRS, List nestNameRU, List nestPairN) {
type_RS.add(cpBands.getCPSignature(desc));
@@ -390,7 +392,9 @@ public class MetadataBandGroup extends BandSet {
}
/**
- * Returns true if any annotations have been added to this set of bands
+ * Returns true if any annotations have been added to this set of bands.
+ *
+ * @return true if any annotations have been added to this set of bands.
*/
public boolean hasContent() {
return type_RS.size() > 0;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
index 5040532..8405d9e 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/NewAttributeBands.java
@@ -952,8 +952,8 @@ public class NewAttributeBands extends BandSet {
* Renumber any bytecode indexes or offsets as described in section 5.5.2
of
* the pack200 specification
*
- * @param bciRenumbering
- * @param labelsToOffsets
+ * @param bciRenumbering TODO
+ * @param labelsToOffsets TODO
*/
public void renumberBci(IntList bciRenumbering, Map labelsToOffsets) {
for (Iterator iterator = attributeLayoutElements.iterator();
iterator.hasNext();) {
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Adapter.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Adapter.java
index 8fc7784..5e0f21c 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Adapter.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Adapter.java
@@ -50,8 +50,8 @@ public abstract class Pack200Adapter {
}
/**
- * Completion between 0..1
- * @param value
+ * Completion between 0..1.
+ * @param value Completion between 0..1.
*/
protected void completed(double value) {
firePropertyChange("pack.progress", null,
String.valueOf((int)(100*value))); //$NON-NLS-1$
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/PackingOptions.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/PackingOptions.java
index bfee2e1..060b230 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/PackingOptions.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/PackingOptions.java
@@ -71,7 +71,7 @@ public class PackingOptions {
* LocalVariableTypeTable attributes) are stripped when reading the input
* class files and not included in the output archive.
*
- * @param stripDebug
+ * @param stripDebug If true, all debug attributes.
*/
public void setStripDebug(boolean stripDebug) {
this.stripDebug = stripDebug;
@@ -102,8 +102,8 @@ public class PackingOptions {
}
/**
- * Set the compression effort level (0-9, equivalent to -E command line
option)
- * @param effort
+ * Sets the compression effort level (0-9, equivalent to -E command line
option)
+ * @param effort the compression effort level, 0-9.
*/
public void setEffort(int effort) {
this.effort = effort;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/PackingUtils.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/PackingUtils.java
index 969d50c..b2bece6 100644
---
a/src/main/java/org/apache/commons/compress/harmony/pack200/PackingUtils.java
+++
b/src/main/java/org/apache/commons/compress/harmony/pack200/PackingUtils.java
@@ -91,7 +91,7 @@ public class PackingUtils {
*
* @param jarInputStream
* the jar input stream
- * @param jarOutputStream
+ * @param outputStream
* the jar output stream
* @throws IOException If an I/O error occurs.
*/
@@ -123,7 +123,7 @@ public class PackingUtils {
*
* @param jarFile
* the input jar file
- * @param jarOutputStream
+ * @param outputStream
* the jar output stream
* @throws IOException If an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
index 6f79042..494a0b3 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Segment.java
@@ -58,11 +58,7 @@ public class Segment implements ClassVisitor {
* The main method on Segment. Reads in all the class files, packs them and
* then writes the packed segment out to the given OutputStream.
*
- * @param classes
- * List of Pack200ClassReaders, one for each class file in the
- * segment
- * @param files
- * List of Archive.Files, one for each file in the segment
+ * @param segmentUnit TODO
* @param out
* the OutputStream to write the packed Segment to
* @param options
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
index 1ee4c2d..cbf0e32 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/Archive.java
@@ -208,9 +208,10 @@ public class Archive {
/**
* If removePackFile is set to true, the input file is deleted after
- * unpacking
+ * unpacking.
*
- * @param removePackFile
+ * @param removePackFile If true, the input file is deleted after
+ * unpacking.
*/
public void setRemovePackFile(boolean removePackFile) {
this.removePackFile = removePackFile;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
index 224864d..d42d27a 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/BandSet.java
@@ -239,7 +239,7 @@ public abstract class BandSet {
}
/**
- * Helper method to parse <i>count</i> references from <code>in</code>,
+ * Parses <i>count</i> references from <code>in</code>,
* using <code>codec</code> to decode the values as indexes into
* <code>reference</code> (which is populated prior to this call). An
* exception is thrown if a decoded index falls outside the range
@@ -255,6 +255,7 @@ public abstract class BandSet {
* the number of references to decode
* @param reference
* the array of values to use for the references
+ * @return Parsed references.
*
* @throws IOException
* if a problem occurs during reading from the underlying
stream
@@ -269,7 +270,7 @@ public abstract class BandSet {
}
/**
- * Helper method to parse <i>count</i> references from <code>in</code>,
+ * Parses <i>count</i> references from <code>in</code>,
* using <code>codec</code> to decode the values as indexes into
* <code>reference</code> (which is populated prior to this call). An
* exception is thrown if a decoded index falls outside the range
@@ -286,6 +287,7 @@ public abstract class BandSet {
* the numbers of references to decode for each array entry
* @param reference
* the array of values to use for the references
+ * @return Parsed references.
*
* @throws IOException
* if a problem occurs during reading from the underlying
stream
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
index 66e4768..0b5c275 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/ClassBands.java
@@ -1177,11 +1177,11 @@ public class ClassBands extends BandSet {
/**
* Parse the class metadata bands and return the number of backwards
- * callables
+ * callables.
*
- * @param in
- * @param classAttrCalls
- * @return
+ * @param in TODO
+ * @param classAttrCalls TODO
+ * @return the number of backwards callables.
* @throws Pack200Exception TODO
* @throws IOException If an I/O error occurs.
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/IcBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/IcBands.java
index bf0d16f..8aa226c 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/IcBands.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/IcBands.java
@@ -48,7 +48,7 @@ public class IcBands extends BandSet {
private Map outerClassToTuples;
/**
- * @param segment
+ * @param segment TODO
*/
public IcBands(Segment segment) {
super(segment);
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/IcTuple.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/IcTuple.java
index b416a7b..580b7e7 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/IcTuple.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/IcTuple.java
@@ -42,6 +42,7 @@ public class IcTuple {
* @param cIndex the index of C in cpClass
* @param c2Index the index of C2 in cpClass, or -1 if C2 is null
* @param nIndex the index of N in cpUTF8, or -1 if N is null
+ * @param tIndex TODO
*/
public IcTuple(String C, int F, String C2, String N, int cIndex, int
c2Index, int nIndex, int tIndex) {
this.C = C;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
index fb0f8dd..80203ee 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/NewAttributeBands.java
@@ -73,6 +73,9 @@ public class NewAttributeBands extends BandSet {
* Parse the bands relating to this AttributeLayout and return the correct
* class file attributes as a List of {@link Attribute}.
*
+ * @param in parse source.
+ * @param occurrenceCount TODO
+ * @return Class file attributes as a List of {@link Attribute}.
* @throws IOException If an I/O error occurs.
* @throws Pack200Exception TODO
*/
@@ -95,9 +98,9 @@ public class NewAttributeBands extends BandSet {
* Get one attribute at the given index from the various bands. The correct
* bands must have already been read in.
*
- * @param index
- * @param elements
- * @return
+ * @param index TODO
+ * @param elements TODO
+ * @return attribute at the given index.
*/
private Attribute getOneAttribute(int index, List elements) {
NewAttribute attribute = new NewAttribute(segment.getCpBands()
@@ -301,10 +304,10 @@ public class NewAttributeBands extends BandSet {
}
/**
- * Read a UnionCase from the stream
+ * Read a UnionCase from the stream.
*
- * @param stream
- * @return
+ * @param stream source stream.
+ * @return A UnionCase from the stream.
* @throws IOException If an I/O error occurs.
*/
private UnionCase readNextUnionCase(StringReader stream) throws
IOException {
@@ -349,9 +352,9 @@ public class NewAttributeBands extends BandSet {
/**
* Read the bands associated with this part of the layout.
*
- * @param in
- * @param count
- * @throws Pack200Exception
+ * @param in TODO
+ * @param count TODO
+ * @throws Pack200Exception Bad archive.
* @throws IOException If an I/O error occurs.
*/
public void readBands(InputStream in, int count) throws IOException,
@@ -920,9 +923,11 @@ public class NewAttributeBands extends BandSet {
/**
* Returns the {@link BHSDCodec} that should be used for the given layout
- * element
+ * element.
*
- * @param layoutElement
+ * @param layoutElement TODO
+ * @return the {@link BHSDCodec} that should be used for the given layout
+ * element.
*/
public BHSDCodec getCodec(String layoutElement) {
if (layoutElement.indexOf('O') >= 0) {
@@ -941,11 +946,11 @@ public class NewAttributeBands extends BandSet {
}
/**
- * Utility method to get the contents of the given stream, up to the next
+ * Gets the contents of the given stream, up to the next
* ']', (ignoring pairs of brackets '[' and ']')
*
- * @param stream
- * @return
+ * @param stream input stream.
+ * @return the contents of the given stream.
* @throws IOException If an I/O error occurs.
*/
private String readUpToMatchingBracket(StringReader stream)
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/Segment.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/Segment.java
index 88d5684..903cba5 100644
--- a/src/main/java/org/apache/commons/compress/harmony/unpack200/Segment.java
+++ b/src/main/java/org/apache/commons/compress/harmony/unpack200/Segment.java
@@ -468,6 +468,8 @@ public class Segment {
* Unpacks a packed stream (either .pack. or .pack.gz) into a corresponding
* JarOuputStream.
*
+ * @param in a packed stream.
+ * @param out output stream.
* @throws Pack200Exception
* if there is a problem unpacking
* @throws IOException
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
index c1b49c8..40b62f3 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/SegmentConstantPool.java
@@ -30,8 +30,9 @@ public class SegmentConstantPool {
private final CpBands bands;
private final SegmentConstantPoolArrayCache arrayCache = new
SegmentConstantPoolArrayCache();
+
/**
- * @param bands
+ * @param bands TODO
*/
public SegmentConstantPool(CpBands bands) {
this.bands = bands;
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPClass.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPClass.java
index 366ceaf..446c04c 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPClass.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPClass.java
@@ -33,7 +33,7 @@ public class CPClass extends ConstantPoolEntry {
/**
* Creates a new CPClass
*
- * @param name
+ * @param name TODO
* @param globalIndex
* index in CpBands
* @throws NullPointerException
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
index 264d878..eeb8429 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPConstant.java
@@ -27,8 +27,8 @@ public abstract class CPConstant extends ConstantPoolEntry {
/**
* Create a new CPConstant
*
- * @param tag
- * @param value
+ * @param tag TODO
+ * @param value TODO
* @param globalIndex
* index in CpBands
* @throws NullPointerException
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
index 0a5c35a..8c79d4e 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPMember.java
@@ -36,10 +36,10 @@ public class CPMember extends ClassFileEntry {
/**
* Create a new CPMember
*
- * @param name
- * @param descriptor
- * @param flags
- * @param attributes
+ * @param name TODO
+ * @param descriptor TODO
+ * @param flags TODO
+ * @param attributes TODO
* @throws NullPointerException
* if name or descriptor is null
*/
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
index 86a9cb9..ac7bb0c 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPNameAndType.java
@@ -37,8 +37,8 @@ public class CPNameAndType extends ConstantPoolEntry {
/**
* Create a new CPNameAndType
*
- * @param name
- * @param descriptor
+ * @param name TODO
+ * @param descriptor TODO
* @param globalIndex - index in CpBands
* @throws NullPointerException
* if name or descriptor is null
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
index 08250d1..c46a5ad 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPRef.java
@@ -34,9 +34,9 @@ public abstract class CPRef extends ConstantPoolEntry {
/**
* Create a new CPRef
*
- * @param type
- * @param className
- * @param descriptor
+ * @param type TODO
+ * @param className TODO
+ * @param descriptor TODO
* @param globalIndex
* index in CpBands
* @throws NullPointerException
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPString.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPString.java
index cd00c3e..71562b7 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPString.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPString.java
@@ -43,7 +43,7 @@ public class CPString extends CPConstant {
/**
* Allows the constant pool entries to resolve their nested entries
*
- * @param pool
+ * @param pool TODO
*/
protected void resolve(ClassConstantPool pool) {
super.resolve(pool);
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPUTF8.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPUTF8.java
index de7d943..6f00359 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPUTF8.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/CPUTF8.java
@@ -29,7 +29,7 @@ public class CPUTF8 extends ConstantPoolEntry {
/**
* Creates a new CPUTF8 instance
*
- * @param utf8
+ * @param utf8 TODO
* @param globalIndex - index in CpBands
* @throws NullPointerException
* if utf8 is null
diff --git
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
index 70a24eb..1c9a8e0 100644
---
a/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
+++
b/src/main/java/org/apache/commons/compress/harmony/unpack200/bytecode/ClassFileEntry.java
@@ -38,9 +38,9 @@ public abstract class ClassFileEntry {
public abstract int hashCode();
/**
- * Allows the constant pool entries to resolve their nested entries
+ * Allows the constant pool entries to resolve their nested entries.
*
- * @param pool
+ * @param pool TODO
*/
protected void resolve(ClassConstantPool pool) {
resolved = true;
