diff options
| author | Damjan Jovanovic <damjan@apache.org> | 2015-08-23 19:26:16 +0000 |
|---|---|---|
| committer | Damjan Jovanovic <damjan@apache.org> | 2015-08-23 19:26:16 +0000 |
| commit | 7fa859c4b25df3326ddda3e603c9833d194b701f (patch) | |
| tree | 9b60952a63d741bb3fe537adbb09af61fa87f17c | |
| parent | 01aadc965ca97f28505418c6fb95a0c4c1f0d160 (diff) | |
More javadoc fixes for building with Java 8.
Notes
59 files changed, 138 insertions, 178 deletions
diff --git a/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java b/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java index d5cf73a1c744..5a387fb9bf57 100644 --- a/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java +++ b/javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java @@ -467,6 +467,8 @@ public class InterfaceContainer implements Cloneable /** The iterator keeps a copy of the list. Changes to InterfaceContainer do not * affect the data of the iterator. Conversly, changes to the iterator are effect * InterfaceContainer. + * + * @param index */ synchronized public ListIterator listIterator(int index) { diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java index 20e997bc809b..f3e63be1e0b3 100644 --- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java +++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySet.java @@ -122,7 +122,7 @@ XMultiPropertySet * initialization of the inheriting class (i.e. within the contructor) * @param name The property's name (Property.Name). * @param handle The property's handle (Property.Handle). - * @param Type The property's type (Property.Type). + * @param type The property's type (Property.Type). * @param attributes The property's attributes (Property.Attributes). * @param id Identifies the property's storage. */ @@ -140,8 +140,7 @@ XMultiPropertySet * Registration has to occur during * initialization of the inheriting class (i.e. within the contructor). * @param name The property's name (Property.Name). - * @param handle The property's handle (Property.Handle). - * @param Type The property's type (Property.Type). + * @param type The property's type (Property.Type). * @param attributes The property's attributes (Property.Attributes). * @param id Identifies the property's storage. */ @@ -563,11 +562,11 @@ XMultiPropertySet * {@link #setFastPropertyValue XFastPropertySet.setFastPropertyValue} * and {@link #setPropertyValues XMultiPropertySet.setPropertyValues}. * If this method fails, that is, it returns false or throws an exception, then no listeners are notified and the - * property value, that was intended to be changed, remains untouched.<br /> This method does not have to deal with property attributes, such as + * property value, that was intended to be changed, remains untouched.<br> This method does not have to deal with property attributes, such as * PropertyAttribute.READONLY or PropertyAttribute.MAYBEVOID. The processing of these attributes occurs - * in the calling methods.<br /> + * in the calling methods.<br> * Only if this method returns successfully further processing, such - * as listener notification and finally the modifiction of the property's value, will occur.<br /> + * as listener notification and finally the modifiction of the property's value, will occur.<br> * * The actual modification of a property's value is done by {@link #setPropertyValueNoBroadcast setPropertyValueNoBroadcast} * which is called subsequent to convertPropertyValue. @@ -593,10 +592,10 @@ XMultiPropertySet * Then, no conversion is necessary, since they can hold all possible values. However, if * the member is an Object and <em>setVal</em> is an Any then the object contained in the any is assigned to * the member. The extra type information which exists as Type object in the Any will get lost. If this is not - * intended then use an Any variable rather then an Object.<br /> + * intended then use an Any variable rather then an Object.<br> * If a member is an Object or Any and the argument <em>setVal</em> is an Object, other than String or array, * then it is presumed to be an UNO object and queried for XInterface. If successful, the out-param <em>newVal</em> - * returns the XInterface.<br /> + * returns the XInterface.<br> * If a member is an UNO interface, then <em>setVal</em> is queried for this interface and the result is returned. * If <em>setVal</em> is null then <em>newVal</em> will be null too after return. * <p> @@ -793,7 +792,7 @@ XMultiPropertySet * If a property has the READONLY attribute set, and one of the setter methods, such as setPropertyValue, has been * called, then this method is not going to be called. * @param property the property for which the new value is set - * @param value the new value for the property. + * @param newVal the new value for the property. * @throws com.sun.star.lang.WrappedTargetException An exception, which has to be made known to the caller, * occurred during the setting of the value. */ diff --git a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java index 238d74a6fe6a..008b05efdda5 100644 --- a/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java +++ b/javaunohelper/com/sun/star/lib/uno/helper/PropertySetMixin.java @@ -193,7 +193,7 @@ public final class PropertySetMixin { @param newValue the property value corresponding to the new attribute value. This is only used as <code>com.sun.star.beans.PropertyChangeEvent.NewValue</code>, which is - rather useless, anyway (see “Using the Observer Pattern&rdquo: in + rather useless, anyway (see “Using the Observer Pattern” in <a href="http://tools.openoffice.org/CodingGuidelines.sxw"> <cite>OpenOffice.org Coding Guidelines</cite></a>), <em>unless</em> the attribute that is going to be set is constrained. If the attribute diff --git a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocumentMergerImpl.java b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocumentMergerImpl.java index 4d90d87dc86f..51dd06be8edb 100644 --- a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocumentMergerImpl.java +++ b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocumentMergerImpl.java @@ -44,7 +44,7 @@ import org.openoffice.xmerge.util.Debug; * AportisDoc implementation of <code>DocumentMerger</code> * for the {@link * org.openoffice.xmerge.converter.xml.sxw.aportisdoc.PluginFactoryImpl - * PluginFactoryImpl}.</p> + * PluginFactoryImpl}. */ public class DocumentMergerImpl implements DocumentMerger { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java index d31714f7eca0..86dbfd926d1a 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java @@ -44,9 +44,6 @@ public class BeginningOfFile implements BIFFRecord { /** * Constructor that initializes the member values. - * - * @param ver Version Number - * Substream type (workbook = 0x05, worksheet = 0x10) */ public BeginningOfFile(boolean global) { setVersion((short) 271); @@ -61,6 +58,10 @@ public class BeginningOfFile implements BIFFRecord { read(is); } + /** + * + * @param version Version Number + */ private void setVersion(short version) { this.version = EndianConverter.writeShort(version); } @@ -79,6 +80,10 @@ public class BeginningOfFile implements BIFFRecord { subStream = EndianConverter.writeShort((short) 0x10); } + /** + * + * @return Substream type (workbook = 0x05, worksheet = 0x10) + */ int getSubStreamType() { return EndianConverter.readShort(subStream); } diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java index c078e87b4c60..91c3ce6d2249 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java @@ -49,8 +49,7 @@ public class BlankCell extends CellValue { * Constructs a <code>BlankCell</code> using specified attributes * * @param row row number - * @param col column number - * @param cellContents contents of the cell + * @param column column number * @param ixfe font index */ public BlankCell(int row, int column, int ixfe) throws IOException { @@ -83,7 +82,7 @@ public class BlankCell extends CellValue { /** * Reads a BlankCell <code>InputStream</code> * - * @param is InputStream containing a BlankCell. + * @param input InputStream containing a BlankCell. */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java index 9eb8cfb916c2..a9f98f54c37e 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java @@ -43,7 +43,7 @@ public class BoolErrCell extends CellValue { * Constructs a BoolErrCell from arguments * * @param row row number - * @param col column number + * @param column column number * @param ixfe font index * @param bBoolErr Boolean value or error value * @param fError Boolean error flag @@ -78,7 +78,7 @@ public class BoolErrCell extends CellValue { /** * Writes a <code>BoolErrCell</code> to the specified <code>Outputstream</code> * - * @param os the <code>OutputStream</code> to write to + * @param output the <code>OutputStream</code> to write to */ public void write(OutputStream output) throws IOException { @@ -95,7 +95,7 @@ public class BoolErrCell extends CellValue { /** * Reads a BoolErrCell from the <code>InputStream</code> * - * @param is InputStream containing a BoolErrCell + * @param input InputStream containing a BoolErrCell */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java index 9d569514fcea..0251ea287dba 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java @@ -64,7 +64,7 @@ public class BoundSheet implements BIFFRecord { * Sets the worksheet name. The sheetname length must be doubled as the * String is stored in unicode format. * - * @param sheetname worksheet name + * @param sheetName worksheet name */ void setSheetName(String sheetName) throws IOException { this.cch = (byte) sheetName.length(); @@ -95,7 +95,7 @@ public class BoundSheet implements BIFFRecord { /** * Write this particular <code>BIFFRecord</code> to the <code>OutputStream</code> * - * @param ouput the <code>OutputStream</code> + * @param output the <code>OutputStream</code> */ public void write(OutputStream output) throws IOException { @@ -111,7 +111,7 @@ public class BoundSheet implements BIFFRecord { * Reads a BoundSheet from the <code>InputStream</code> The byte array * must be twice the size of the String as it uses unicode. * - * @param is InputStream containing the record data + * @param input InputStream containing the record data */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java index 236aabc5d939..41236157fee1 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java @@ -92,7 +92,7 @@ public abstract class CellValue implements BIFFRecord { /** * Writes basic cell value attributes to the specified <code>Outputstream</code> * - * @param os the <code>OutputStream</code> to write to + * @param output the <code>OutputStream</code> to write to */ public void write(OutputStream output) throws IOException { @@ -102,9 +102,9 @@ public abstract class CellValue implements BIFFRecord { } /** - * Writes a<code>LabelCell</code> to the specified <code>Outputstream</code> + * Read a <code>LabelCell</code> from the specified <code>InputStream</code> * - * @param os the <code>OutputStream</code> to write to + * @param input the <code>InputStream</code> to read from */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java index 29da40ccd69f..a0c11b2e556d 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java @@ -50,8 +50,8 @@ public class ColInfo implements BIFFRecord { * * @param colFirst the first column this formatting applies to * @param colLast last column this formatting applies to - * @param coldx column width - * @param grbit options flags + * @param colDX column width + * @param ixfe options flags */ public ColInfo(int colFirst, int colLast, int colDX, int ixfe) { this.colFirst = EndianConverter.writeShort((short)colFirst); @@ -135,7 +135,7 @@ public class ColInfo implements BIFFRecord { /** * Writes a ColInfo to the specified <code>Outputstream</code> * - * @param os the <code>OutputStream</code> to write to + * @param output the <code>OutputStream</code> to write to */ public void write(OutputStream output) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java index cc7bf1b381f5..aa6840face31 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java @@ -32,7 +32,7 @@ import org.openoffice.xmerge.util.EndianConverter; import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants; /** - * Represents a BIFF record defiuning the defualt column width + * Represents a BIFF record defining the default column width */ public class DefColWidth implements BIFFRecord { @@ -40,18 +40,18 @@ public class DefColWidth implements BIFFRecord { private byte[] coldx = new byte[2]; private byte[] ixfe = new byte[2]; -/** - * Constructs a pocket Excel Document from the - * <code>InputStream</code> and assigns it the document name passed in - * - * @param is InputStream containing a Pocket Excel Data file. - */ public DefColWidth() { grbit = new byte[] {0x00, 0x00}; coldx = new byte[] {0x00, 0x09}; ixfe = new byte[] {0x00, 0x00}; } + /** + * Constructs a pocket Excel Document from the + * <code>InputStream</code> and assigns it the document name passed in + * + * @param is InputStream containing a Pocket Excel Data file. + */ public DefColWidth(InputStream is) throws IOException { read(is); } diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java index f503d27a241e..d59a78506719 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java @@ -39,12 +39,6 @@ public class DefRowHeight implements BIFFRecord { private byte[] unknown1 = new byte[2]; private byte[] unknown2 = new byte[2]; - /** - * Constructs a pocket Excel Document from the - * <code>InputStream</code> and assigns it the document name passed in - * - * @param is InputStream containing a Pocket Excel Data file. - */ public DefRowHeight() { unknown1 = new byte[] {(byte)0x00, (byte)0x00}; unknown2 = new byte[] {(byte)0xFF, (byte)0x00}; diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java index 4ef1c8e6076f..b0b0b0ed4857 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java @@ -50,11 +50,6 @@ public class DefinedName implements BIFFRecord { private String definition = new String(""); private Workbook wb; - /** - * Constructs a Defined Name from the <code>InputStream</code> - * - * @param is InputStream containing the record data - */ public DefinedName(NameDefinition nd, Workbook wb) throws IOException { fh.setWorkbook(wb); @@ -95,7 +90,7 @@ public class DefinedName implements BIFFRecord { * Reads a Defined Name from the <code>InputStream</code> The byte array * must be twice the size of the String as it uses unicode. * - * @param is InputStream containing the record data + * @param input InputStream containing the record data */ public int read(InputStream input) throws IOException { @@ -126,7 +121,7 @@ public class DefinedName implements BIFFRecord { /** * Write this particular <code>BIFFRecord</code> to the <code>OutputStream</code> * - * @param ouput the <code>OutputStream</code> + * @param output the <code>OutputStream</code> */ public void write(OutputStream output) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java index 7250a5c88ce5..9839c485832c 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java @@ -276,7 +276,7 @@ org.openoffice.xmerge.converter.xml.OfficeConstants { /** * Compare two ExtendedFormat to see if the font index is the same * - * @param the ExtendedFormat to be used in the comaprison + * @param rhs the ExtendedFormat to be used in the comaprison * @return boolean if the two are the same otherwise false */ public boolean compareTo(ExtendedFormat rhs) { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java index 5f0eed6cb544..f584d5232d3b 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java @@ -52,7 +52,7 @@ public class FloatNumber extends CellValue { * Constructs a <code>FloatNumber</code> using specified attributes * * @param row row number - * @param col column number + * @param column column number * @param cellContents contents of the cell * @param ixfe font index */ diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java index 25c482540668..c7b036323e39 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java @@ -56,13 +56,6 @@ public class FontDescription implements BIFFRecord { public static final int UNDERLINE = 0x01; public static final int ITALIC = 0x02; - /** - * Constructs a FontDescription from the bold italic and undelrine attributes - * - * @param italic Italic attribute - * @param bold Bold attribute - * @param underline Underline attribute - */ public FontDescription(Format fmt) throws IOException { Debug.log(Debug.TRACE,"Building FontDescriptor based on Format : " + fmt); @@ -230,7 +223,7 @@ public class FontDescription implements BIFFRecord { /** * Constructs a Font Description from the <code>InputStream</code> * - * @param is InputStream containing a <code>FontDescription</code> + * @param input InputStream containing a <code>FontDescription</code> */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java index 4f5776ec59cd..1d37831a2baf 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java @@ -51,10 +51,9 @@ public class Formula extends CellValue implements OfficeConstants { * Constructs a <code>Formula</code> using specified attributes * * @param row row number - * @param col column number + * @param column column number * @param cellContents contents of the cell * @param ixfe font index - * @param value the value of the cell */ public Formula(int row, int column, String cellContents, int ixfe, Format fmt, Workbook wb) throws Exception { @@ -112,7 +111,7 @@ public class Formula extends CellValue implements OfficeConstants { * Translates a <code>String</code> written in infix which represents a * formula into a byte[] what can be written to pocket excel file. * - * @param formula string + * @param inFormula formula string */ public void setFormula(String inFormula) throws Exception { @@ -171,7 +170,7 @@ public class Formula extends CellValue implements OfficeConstants { /** * Writes the Formula record to the <code>OutputStream</code> * - * @param the <code>OutputStream</code> being written to + * @param output the <code>OutputStream</code> being written to */ public void write(OutputStream output) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java index eb23d23874f9..6e85b9f50a09 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java @@ -44,7 +44,7 @@ public class LabelCell extends CellValue { * Constructs a <code>LabelCell</code> using specified attributes * * @param row row number - * @param col column number + * @param column column number * @param cellContents contents of the cell * @param ixfe font index */ @@ -69,7 +69,7 @@ public class LabelCell extends CellValue { /** * Writes a <code>LabelCell</code> to the specified <code>Outputstream</code> * - * @param os the <code>OutputStream</code> to write to + * @param output the <code>OutputStream</code> to write to */ public void write(OutputStream output) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java index ed19ee8e075e..364ba5bc04b2 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java @@ -101,7 +101,7 @@ public class Row implements BIFFRecord { /** * Reads a Row from an <code>InputStream</code> * - * @param is InputStream containing a Pane Record + * @param input InputStream containing a Pane Record */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java index 47b9a13d98d9..3db5794cc685 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java @@ -100,7 +100,7 @@ public class Selection implements BIFFRecord { /** * Reads a Selection Record from the <code>InputStream</code> * - * @param is InputStream containing a Pocket Excel Data file. + * @param input InputStream containing a Pocket Excel Data file. */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java index e32a4ba39bb6..55c7ca752baf 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java @@ -43,9 +43,9 @@ public class StringValue implements BIFFRecord { private byte[] rgch; /** - * Constructs a StringValue Record from an <code>InputStream</code> + * Constructs a StringValue Record from a <code>String</code> * - * @param is InputStream containing a StringValue Record + * @param str */ public StringValue(String str) throws IOException { cch = EndianConverter.writeShort((short) str.length()); @@ -74,7 +74,7 @@ public class StringValue implements BIFFRecord { /** * Reads a StringVlaue Record from an <code>InputStream</code> * - * @param is InputStream containing a StringValue Record + * @param input InputStream containing a StringValue Record */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java index 77fe002426b2..1c6f52b48a0c 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java @@ -87,7 +87,7 @@ public class Window1 implements BIFFRecord { /** * Reads a Window1 Record from an <code>InputStream</code> * - * @param is InputStream containing a Window1 Record + * @param input InputStream containing a Window1 Record */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java index 58b3112481e7..92494060a5ed 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java @@ -123,7 +123,7 @@ public class Window2 implements BIFFRecord { /** * Reads a Window2 Record from an <code>InputStream</code> * - * @param is InputStream containing a Window2 Record + * @param input InputStream containing a Window2 Record */ public int read(InputStream input) throws IOException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java index e73a3dad120c..8f9829773f81 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java @@ -236,7 +236,7 @@ OfficeConstants { /** * Adds a ExtendedFormat record to the workbook * - * @param f the font record to add + * @param fmt the font record to add */ public int addExtendedFormat(Format fmt) throws IOException { @@ -466,12 +466,6 @@ OfficeConstants { } } - /** - * Will create a number of ColInfo recrods based on the column widths - * based in. - * - * @param an integer list representing the column widths - */ public void addNameDefinition(NameDefinition nameDefinition) throws IOException { DefinedName dn = new DefinedName(nameDefinition, this); diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java index 1ffb4c352afd..9b9fe8768488 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java @@ -56,25 +56,18 @@ public class Worksheet { private BeginningOfFile bof; private Eof eof; - /** - * Writes the current workbook to the <code>Outputstream</code> - * - * @param os The destination outputstream - */ public Worksheet(Workbook wb) { this.wb = wb; } /** * Default Contructor - * - * @param os The destination outputstream */ public Worksheet() { } /** - * Writes the current workbook to the <code>Outputstream</code> + * Writes the current workbook to the <code>OutputStream</code> * * @param os The destination outputstream */ @@ -229,7 +222,7 @@ public class Worksheet { * Adds a cell to this worksheet. Current valdid celltypes are * <code>FloatNumber</code>, <code>LabelCell</code> or <code>Formula</code> * - * @param f the font record to add + * @param br */ public void addCell(BIFFRecord br) { cells.add(br); @@ -239,7 +232,7 @@ public class Worksheet { * Adds a number of ColInfo Records to the worksheet base on a list of * clumnwidths passed in * - * @param list of column widths + * @param r list of column widths */ public void addRow(Row r) { rows.add(r); @@ -249,7 +242,7 @@ public class Worksheet { * Adds a number of ColInfo Records to the worksheet base on a list of * clumnwidths passed in * - * @param list of column widths + * @param c list of column widths */ public void addCol(ColInfo c) { colInfo.add(c); diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaCompiler.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaCompiler.java index a00141c01620..82451afe219d 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaCompiler.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaCompiler.java @@ -45,7 +45,7 @@ import org.openoffice.xmerge.util.Debug; * else if token is close bracket * pop from stack into result until close bracket or function * else - * while stack.top.priority >= token.priority + * while stack.top.priority >= token.priority * add stack.pop to result * push token onto stack * </pre> diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java index a788da7b406c..3e7999322357 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java @@ -32,7 +32,7 @@ import org.openoffice.xmerge.util.Debug; /** * This is the Formula Parser based on an article written by Jack Crenshaw. It is a * top down parser with some basic error handling. It handles - * +,-,*,/,>,<,>=,<=,=,<>, unary + and - as well as functions. + * +,-,*,/,>,<,>=,<=,=,<>, unary + and - as well as functions. * The BNF notation for this parser is * <pre> * <expression> ::= <unary op> <term> [<addop>|<logop> <term>] @@ -110,7 +110,7 @@ public class FormulaParser { } /** - * Identify <, >, <=, >=, =, <> using the index to find the current character(s) + * Identify <, >, <=, >=, =, <> using the index to find the current character(s) * * @return A boolean returning the result of the comparison */ @@ -131,9 +131,9 @@ public class FormulaParser { } /** - * Identify <, >, <=, >=, =, <> + * Identify <, >, <=, >=, =, <> * - * @param The <code>String</code> which is to be identified + * @param op The <code>String</code> which is to be identified * @return A boolean returning the result of the comparison */ private boolean isLogicalOp(String op) { @@ -397,7 +397,7 @@ public class FormulaParser { * Will keep pulling valid logical operators from the formula and return * the resultant <code>String</code>. * - * @return a <code>String<code> representing a logical operator + * @return a <code>String</code> representing a logical operator */ private String getLogicalOperator() throws FormulaParsingException { String op = new String(); @@ -535,7 +535,7 @@ public class FormulaParser { /** * Pull a logical operator starting at the current index, add a token for - * that operator to the tokenVector and call <code>term<code> to parse the + * that operator to the tokenVector and call <code>term</code> to parse the * right hand side of the operator */ private void logicalOp() throws FormulaParsingException { diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/SymbolLookup.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/SymbolLookup.java index bceb625e6559..aaf826bddb06 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/SymbolLookup.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/SymbolLookup.java @@ -44,7 +44,7 @@ public abstract class SymbolLookup { /** * Associate a symbol with a numeric value in the lookup table * @param symbol The symbol that will act as the key in the lookup table - * @param value The value to be associated with a given symbol + * @param id The value to be associated with a given symbol */ public void addEntry(String symbol, int id) { Integer iObj = new Integer(id); diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java index ba9408fc319b..02ed8a6bc360 100644 --- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java +++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java @@ -284,7 +284,7 @@ public class TokenEncoder { /** * A Cell Reference Encoder (It supports absolute and relative addressing) * - * @param t <code>Token</code> to be encoded + * @param cellCoordinates * @return A <code>Vector</code> of pexcel <code>Byte</code> */ private byte[] encodeCellCoordinates(String cellCoordinates) { @@ -367,7 +367,7 @@ public class TokenEncoder { /** * This function will find the sheetname index for a given String * - * @param t <code>Token</code> to be encoded + * @param s * @return A <code>Vector</code> of pexcel <code>Byte</code> */ private short findSheetIndex(String s) { diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java index 7fcdadf60a8b..a2f7098d0c14 100644 --- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java +++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java @@ -69,7 +69,7 @@ public final class DocumentDeserializerImpl /** - * Initialises a new <code>DocumentDeserializerImpl</code> using the + * <p>Initialises a new <code>DocumentDeserializerImpl</code> using the * supplied <code>ConvertData</code>.</p> * * <p>The <code>Document</code> objects in the <code>ConvertData</code> diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentMergerImpl.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentMergerImpl.java index 336ae9430a87..8a762c2857c0 100644 --- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentMergerImpl.java +++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentMergerImpl.java @@ -44,7 +44,7 @@ import org.openoffice.xmerge.util.Debug; * PocketWord implementation of <code>DocumentMerger</code> * for the {@link * org.openoffice.xmerge.converter.xml.sxw.pocketword.PluginFactoryImpl - * PluginFactoryImpl}.</p> + * PluginFactoryImpl}. */ public class DocumentMergerImpl implements DocumentMerger { diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentSerializerImpl.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentSerializerImpl.java index 04e0ef32673f..216cfc775ba4 100644 --- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentSerializerImpl.java +++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentSerializerImpl.java @@ -48,7 +48,7 @@ import java.io.IOException; * org.openoffice.xmerge.converter.xml.sxw.pocketword.PluginFactoryImpl * PluginFactoryImpl}.</p> * - * <p>This converts an OpenOffice.org XML Writer files to a Pocket Word file<.</p> + * <p>This converts an OpenOffice.org XML Writer files to a Pocket Word file.</p> * * @author Mark Murnane * @version 1.1 @@ -72,7 +72,7 @@ public final class DocumentSerializerImpl * org.openoffice.xmerge.converter.xml.sxw.SxwDocument SxwDocument} * object.</p> * - * @param document The <code>Document</code> to convert. + * @param doc The <code>Document</code> to convert. */ public DocumentSerializerImpl(Document doc) { sxwDoc = (SxwDocument)doc; diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PluginFactoryImpl.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PluginFactoryImpl.java index 26c8f40d7aaa..df72f364b7a8 100644 --- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PluginFactoryImpl.java +++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PluginFactoryImpl.java @@ -90,11 +90,11 @@ public final class PluginFactoryImpl extends SxwPluginFactory /** - * The <code>DocumentDeserializer</code> is used to convert + * <p>The <code>DocumentDeserializer</code> is used to convert * from the Pocket Word <code>Document</code> format to * the OpenOffice.org XML Writer <code>Document</code> format.</p> * - * The <code>ConvertData</code> object is passed along to the + * <p>The <code>ConvertData</code> object is passed along to the * created <code>DocumentDeserializer</code> via its constructor. * The <code>ConvertData</code> is read and converted when the * the <code>DocumentDeserializer</code> object's diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PocketWordDocument.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PocketWordDocument.java index 2e6da2674c34..a22dc30c7700 100644 --- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PocketWordDocument.java +++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/PocketWordDocument.java @@ -101,7 +101,7 @@ public class PocketWordDocument implements Document, PocketWordConstants { * <p>This method reads <code>byte</code> data from the InputStream and * extracts font and paragraph data from the file.</p> * - * @param is InputStream containing a Pocket Word data file. + * @param docData InputStream containing a Pocket Word data file. * * @throws IOException In case of any I/O errors. */ diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/DocumentDeserializerFactory.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/DocumentDeserializerFactory.java index 0e48a225cf32..5b2e3d98e02b 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/DocumentDeserializerFactory.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/DocumentDeserializerFactory.java @@ -38,11 +38,11 @@ package org.openoffice.xmerge; public interface DocumentDeserializerFactory { /** - * The <code>DocumentDeserializer</code> is used to convert + * <p>The <code>DocumentDeserializer</code> is used to convert * from the "Device" <code>Document</code> format to * the "Office" <code>Document</code> format.</p> * - * The <code>ConvertData</code> object is passed along to the + * <p>The <code>ConvertData</code> object is passed along to the * created <code>DocumentDeserializer</code> via its constructor. * The <code>ConvertData</code> is read and converted when the * the <code>DocumentDeserializer</code> object's diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDocument.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDocument.java index 2da4601e4a92..51171e8c8fbb 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDocument.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDocument.java @@ -116,7 +116,7 @@ public class PalmDocument /** * Writes the <code>PalmDocument</code> to an <code>OutputStream</code>. * - * @param is The <code>OutputStream</code> to write the content. + * @param os The <code>OutputStream</code> to write the content. * * @throws IOException If any I/O error occurs. */ diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbEncoder.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbEncoder.java index 19780752705f..9450a04dafde 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbEncoder.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbEncoder.java @@ -109,7 +109,7 @@ public final class PdbEncoder { * top of the PDB.</li> * <li>1 byte of <code>Record</code> attribute.</li> * <li>3 bytes unique <code>Record</code> ID.</li> - * </ul></p> + * </ul> * * <p>There should be a total of <code>header.numRecords</code> * of <code>Record</code> index info</p>. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/Record.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/Record.java index e3bcd6d6a68e..65b788fe16af 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/Record.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/Record.java @@ -134,7 +134,7 @@ public final class Record { * <code>Record</code> length followed by the data in this * <code>Record</code> object. * - * @param out The <code>OutputStream</code> to write the object. + * @param outs The <code>OutputStream</code> to write the object. * * @throws IOException If any I/O error occurs. */ @@ -151,7 +151,7 @@ public final class Record { * Read the necessary data to create a PDB from * the <code>InputStream</code>. * - * @param in The <code>InputStream</code> to read data from + * @param ins The <code>InputStream</code> to read data from * in order to restore the <code>object</code>. * * @throws IOException If any I/O error occurs. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedXMLObject.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedXMLObject.java index 9e23079182d2..4ebb2d36c4d4 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedXMLObject.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedXMLObject.java @@ -134,7 +134,7 @@ public class EmbeddedXMLObject extends EmbeddedObject { /** * Sets the settings data for the embedded object. * - * @param styles DOM representation of the object's styles. + * @param settings DOM representation of the object's styles. */ public void setSettingsDOM(Document settings) { settingsDOM = settings; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java index 1747e0afef39..974920e96c86 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java @@ -1119,7 +1119,7 @@ public abstract class OfficeDocument /** - * <p>Hacked code to filter <!DOCTYPE> tag before + * <p>Hacked code to filter <!DOCTYPE> tag before * sending stream to parser.</p> * * <p>This hacked code needs to be changed later on.</p> @@ -1128,7 +1128,7 @@ public abstract class OfficeDocument * to turn off processing of dtds. Current set of dtds * have bugs, processing them will throw exceptions.</p> * - * <p>This is a simple hack that assumes the whole <!DOCTYPE> + * <p>This is a simple hack that assumes the whole <!DOCTYPE> * tag are all in the same line. This is sufficient for * current StarOffice 6.0 generated XML files. Since this * hack really needs to go away, I don't want to spend @@ -1138,7 +1138,7 @@ public abstract class OfficeDocument * * @param is <code>InputStream</code> to be filtered. * - * @return Reader value without the <!DOCTYPE> tag. + * @return Reader value without the <!DOCTYPE> tag. * * @throws IOException If any I/O error occurs. */ diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/ParaStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/ParaStyle.java index 860f40e425f1..18c9ff1e695f 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/ParaStyle.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/ParaStyle.java @@ -142,7 +142,7 @@ class alignment extends conversionAlgorithm { * in bits indicated by LH_VALUEMASK. * </td></tr><tr><td> * TEXT_ALIGN </td><td>ALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUST, ALIGN_LEFT - * </td></tr></table></p> + * </td></tr></table> * * @author David Proulx */ @@ -266,9 +266,9 @@ public class ParaStyle extends Style implements Cloneable { * Constructor for use when going from client device format to DOM. * * @param name Name of the <code>Style</code>. Can be null. - * @param family Family of the <code>Style</code> - usually + * @param familyName Family of the <code>Style</code> - usually * <i>paragraph</i>, <i>text</i>, etc. Can be null. - * @param parent Name of the parent <code>Style</code>, or null + * @param parentName Name of the parent <code>Style</code>, or null * if none. * @param attribs Array of attributes to set. * @param values Array of values to set. @@ -289,13 +289,13 @@ public class ParaStyle extends Style implements Cloneable { * format to DOM. * * @param name Name of the <code>Style</code>. Can be null. - * @param family Family of the <code>Style</code> - usually + * @param familyName Family of the <code>Style</code> - usually * <i>paragraph</i>, <i>text</i>, etc. Can be null. - * @param parent Name of the parent <code>Style</code>, or + * @param parentName Name of the parent <code>Style</code>, or * null if none. * @param attribs Array of attributes indices to set. * @param values Array of values to set. - * @param sc The <code>StyleCatalog</code>, which is used for + * @param lookup The <code>StyleCatalog</code>, which is used for * looking up ancestor <code>Style</code> objects. */ public ParaStyle(String name, String familyName, String parentName, @@ -373,7 +373,7 @@ public class ParaStyle extends Style implements Cloneable { * Set an attribute for this paragraph <code>Style</code>. * * @param attr The attribute index to set. - * @apram value The attribute value to set. + * @param value The attribute value to set. */ public void setAttribute(int attr, String value) { isSet[attr] = true; @@ -496,7 +496,7 @@ public class ParaStyle extends Style implements Cloneable { /** * Create the <code>Node</code> with the specified elements. * - * @parentDoc Parent <code>Document</code> of the + * @param parentDoc <code>Document</code> of the * <code>Node</code> to create. * @param name Name of the <code>Node</code>. * diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/StyleCatalog.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/StyleCatalog.java index 0a55dcf5ec50..028ed2a2fb58 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/StyleCatalog.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/StyleCatalog.java @@ -207,7 +207,7 @@ public class StyleCatalog { /** - * Given a <code>Style</code> <code>s<code> return all + * Given a <code>Style</code> <code>s</code> return all * <code>Style</code> objects that match. * * @param s <code>Style</code> to match. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java index 051a64d6864e..93a6ceb6ec62 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java @@ -74,7 +74,7 @@ public class TextStyle extends Style implements Cloneable { /** * Constructor for use when going from DOM to client device format. * - * @param Node The <i>style:style</i> <code>Node</code> containing + * @param node The <i>style:style</i> <code>Node</code> containing * the <code>Style</code>. (This <code>Node</code> is * assumed have a <i>family</i> attribute of <i>text</i>). * @param sc The <code>StyleCatalog</code>, which is used for diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/BookSettings.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/BookSettings.java index 620e16fc3dc5..0d9c1359278e 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/BookSettings.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/BookSettings.java @@ -52,8 +52,7 @@ public class BookSettings implements OfficeConstants { /** * Default Constructor for a <code>BookSettings</code> * - * @param dimension if it's a row the height, a column the width - * @param repeated + * @param root */ public BookSettings(Node root) { readNode(root); diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/CellStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/CellStyle.java index f0f07a2dbf5f..37d9e30e1ce7 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/CellStyle.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/CellStyle.java @@ -46,7 +46,7 @@ public class CellStyle extends Style implements Cloneable { /** * Constructor for use when going from DOM to client device format. * - * @param Node The <i>style:style</i> <code>Node</code> containing + * @param node The <i>style:style</i> <code>Node</code> containing * the <code>Style</code>. (This <code>Node</code> is * assumed have a <i>family</i> attribute of <i>text</i>). * @param sc The <code>StyleCatalog</code>, which is used for diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java index d9546dee985a..963602975d19 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/ColumnRowInfo.java @@ -46,8 +46,7 @@ public class ColumnRowInfo { /** * Constructor for a <code>ColumnRowInfo</code> * - * @param dimension if it's a row the height, a column the width - * @param repeated + * @param type whether Row or column record */ public ColumnRowInfo(int type) { @@ -82,7 +81,7 @@ public class ColumnRowInfo { /** * sets the definition * - * @param newDefinition sets the definition + * @param fmt sets the definition */ public void setFormat(Format fmt) { @@ -110,9 +109,9 @@ public class ColumnRowInfo { } /** - * sets the definition + * Sets the definition * - * @param newDefinition sets the definition + * @param dimension */ public void setSize(int dimension) { diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/DocumentMergerImpl.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/DocumentMergerImpl.java index 08f7456c39f8..0dbae5d79f58 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/DocumentMergerImpl.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/DocumentMergerImpl.java @@ -49,7 +49,7 @@ import org.openoffice.xmerge.util.Debug; * Generic small device implementation of <code>DocumentMerger</code> for * the {@link * org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory - * SxcPluginFactory}. Used with SXC <code>Document</code> objects.</p> + * SxcPluginFactory}. Used with SXC <code>Document</code> objects. */ public class DocumentMergerImpl implements DocumentMerger { diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/Format.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/Format.java index 889b0e0fab56..e3e1f8bed254 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/Format.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/Format.java @@ -295,7 +295,7 @@ public class Format implements Cloneable { /** * Set the font used for this cell. * - * @param fontName The name of the font. + * @param fontSize */ public void setFontSize(int fontSize) { sizeInPoints = fontSize; @@ -312,9 +312,9 @@ public class Format implements Cloneable { } /** - * Set the alignmen used for this cell. + * Set the alignment used for this cell. * - * @param fontName The name of the font. + * @param vertAlign */ public void setVertAlign(int vertAlign) { this.vertAlign = vertAlign; @@ -331,9 +331,9 @@ public class Format implements Cloneable { } /** - * Set the alignmen used for this cell. + * Set the alignment used for this cell. * - * @param fontName The name of the font. + * @param align */ public void setAlign(int align) { this.align = align; @@ -351,7 +351,7 @@ public class Format implements Cloneable { /** * Set the Foreground <code>Color</code> for this cell. * - * @param color A <code>Color</code> object representing the + * @param c A <code>Color</code> object representing the * foreground color. */ public void setForeground(Color c) { @@ -373,7 +373,7 @@ public class Format implements Cloneable { /** * Set the Background <code>Color</code> for this cell * - * @param color A <code>Color</code> object representing + * @param c A <code>Color</code> object representing * the background color. */ public void setBackground(Color c) { @@ -433,7 +433,7 @@ public class Format implements Cloneable { * than this <code>Style</code>, and nothing it specifies * contradicts this <code>Style</code>. * - * @param style The <code>Style</code> to check. + * @param rhs The <code>Style</code> to check. * * @return true if <code>style</code> is a subset, false * otherwise. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/NameDefinition.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/NameDefinition.java index 3ef81e95ba54..3aee7cb738c0 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/NameDefinition.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/NameDefinition.java @@ -135,7 +135,7 @@ public class NameDefinition implements OfficeConstants { /** * Writes out a content.xml entry for this NameDefinition object * - * @param settings a <code>Document</code> object representing the settings.xml + * @param doc a <code>Document</code> object representing the settings.xml * @param root the root xml node to add to */ public void writeNode(org.w3c.dom.Document doc, Node root) { diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java index 2a622be357f9..8e8054c446fe 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/RowStyle.java @@ -44,7 +44,7 @@ public class RowStyle extends Style implements Cloneable { /** * Constructor for use when going from DOM to client device format. * - * @param Node The <i>style:style</i> <code>Node</code> containing + * @param node The <i>style:style</i> <code>Node</code> containing * the <code>Style</code>. (This <code>Node</code> is * assumed have a <i>family</i> attribute of <i>text</i>). * @param sc The <code>StyleCatalog</code>, which is used for @@ -97,7 +97,7 @@ public class RowStyle extends Style implements Cloneable { * <i>text</i>). Can be null. * @param parent Name of parent text <code>Style</code>, or null * for none. - * @param mask The height of this row + * @param rowHeight The height of this row * @param sc The <code>StyleCatalog</code>, which is used for * looking up ancestor <code>Style</code> objects. */ diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SheetSettings.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SheetSettings.java index 5d1c01042e1c..f671f251fd8c 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SheetSettings.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SheetSettings.java @@ -79,8 +79,7 @@ public class SheetSettings implements OfficeConstants { /** * Constructor for a <code>ColumnRowInfo</code> * - * @param dimension if it's a row the height, a column the width - * @param repeated + * @param name */ public SheetSettings(String name) { sheetName = name; @@ -175,12 +174,10 @@ public class SheetSettings implements OfficeConstants { return posLeft; } + /** - * Sets the top row visible in the lower pane and the leftmost column - * visibile in the right pane. + * Gets the top row visible in the lower pane. * - * @param top The top row visible in the lower pane - * @param left The leftmost column visibile in the right pane */ public int getTop() { diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java index c0cb51434fa8..64230ee6be33 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SpreadsheetEncoder.java @@ -104,21 +104,13 @@ public abstract class SpreadsheetEncoder { * @param columnWidths An <code>IntArrayList</code> of column * widths. */ - public abstract void setColumnRows(Vector columnRows) throws IOException; + public abstract void setColumnRows(Vector columnWidths) throws IOException; /** - * Set the width of the columns in the WorkBook. - * - * @param columnWidths An <code>IntArrayList</code> of column - * widths. */ public abstract void setNameDefinition(NameDefinition nd) throws IOException; /** - * Set the width of the columns in the WorkBook. - * - * @param columnWidths An <code>IntArrayList</code> of column - * widths. */ public abstract void addSettings(BookSettings s) throws IOException; } diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/DocumentMergerImpl.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/DocumentMergerImpl.java index 5270fc686fee..7814d984fd40 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/DocumentMergerImpl.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/DocumentMergerImpl.java @@ -44,7 +44,7 @@ import org.openoffice.xmerge.util.Debug; * Xslt implementation of <code>DocumentMerger</code> * for the {@link * org.openoffice.xmerge.converter.xml.xslt.PluginFactoryImpl - * PluginFactoryImpl}.</p> + * PluginFactoryImpl}. */ public class DocumentMergerImpl implements DocumentMerger { diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/NodeMergeAlgorithm.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/NodeMergeAlgorithm.java index 7850568a94e2..db9a290b7e51 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/NodeMergeAlgorithm.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/NodeMergeAlgorithm.java @@ -43,6 +43,6 @@ public interface NodeMergeAlgorithm { * @param modifyNode The <code>Node</code> to be merged. It may * be modified. */ - public void merge(Node orginalNode, Node modifyNode); + public void merge(Node originalNode, Node modifyNode); } diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/IteratorRowCompare.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/IteratorRowCompare.java index 849c0066d59a..d1eecddf6557 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/IteratorRowCompare.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/IteratorRowCompare.java @@ -54,7 +54,7 @@ import org.openoffice.xmerge.converter.xml.OfficeConstants; * If there are more objects in the original sequence than the modified * sequence, then all the extra one in the modified sequence are marked * as delete. - * </li></ol></p> + * </li></ol> * * <p>NOTE: The algorithm will have potential side effect to split rows.</p> * diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/SheetUtil.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/SheetUtil.java index cc38d0f98221..379a5fe881c8 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/SheetUtil.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/SheetUtil.java @@ -45,7 +45,7 @@ public class SheetUtil { * Remove all of the supported attributes. * </li><li> * Remove the first <i>text:p</i> <code>Node</code> for most of the cells. - * </li></ul></p> + * </li></ul> * * @param cc The <code>ConverterCapabilities</code>. * @param node The <code>Node</code>. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/ColourConverter.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/ColourConverter.java index 7db7b32946fe..b84576b8d37d 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/ColourConverter.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/ColourConverter.java @@ -108,7 +108,7 @@ public class ColourConverter { * cases where the 16 colour values are something other than there default * values (e.g. in the case of pocket Excel) * - * @param short[] a 16 bit array mapping the 16 colours to there values + * @param lookup a 16 bit array mapping the 16 colours to their values */ public ColourConverter(short lookup[]) { @@ -151,7 +151,7 @@ public class ColourConverter { * This method maps a Pocket Word colour index value to an RGB value as * used by OpenOffice. * - * @param index The index into Pocket Word's colour table. + * @param colour The index into Pocket Word's colour table. * * @return A Color object representing the RGB value of the Pocket Word * colour. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java index 68a25535776f..ef0ceeaed2fe 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java @@ -39,7 +39,7 @@ import java.util.Properties; /** * This class is used for logging debug messages. * Currently, there are three types of logging: {@link #INFO}, - * {@link #TRACE} & {@link #ERROR}. Use the Debug.properties + * {@link #TRACE} & {@link #ERROR}. Use the Debug.properties * file to set or unset each type. Also use Debug.properties * to set the writer to either <code>System.out</code>, * <code>System.err</code>, or to a file. @@ -265,7 +265,7 @@ public final class Debug { * <p>This logs the message during runtime if debug.info or debug.trace * in the properties file is set to true.</p> * - * @param int Log type, one of the Debug constants + * @param flag Log type, one of the Debug constants * {@link #INFO}, {@link #TRACE}, {@link #ERROR} * or a combination of which or'ed together. * @param msg The message. @@ -287,7 +287,7 @@ public final class Debug { * of the exception passed in. Refer to the other log method * for description. * - * @param int Log type, one of the Debug constants + * @param flag Log type, one of the Debug constants * {@link #INFO}, {@link #TRACE}, {@link #ERROR} * or a combination of which or'ed together. * @param msg The message. diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java index b15a8e00b99a..bca1fad8dfc1 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/ConverterInfoMgr.java @@ -53,7 +53,7 @@ public final class ConverterInfoMgr { * and must have non-null values for DisplayName, ClassImpl, * OfficeMime, and DeviceMime. * - * @param ConverterInfo A <code>ConverterInfo</code> object + * @param ci A <code>ConverterInfo</code> object * describing a plug-in. * * @throws RegistryException If the <code>ConverterInfo</code> @@ -109,16 +109,16 @@ public final class ConverterInfoMgr { /** - * Adds a <code>Vector</code> of converter plug-ins to the registry. - * Each <code>ConverterInfo</code> in the <code>Vector</code> must have + * Adds an <code>Enumeration</code> of converter plug-ins to the registry. + * Each <code>ConverterInfo</code> in the <code>Enumeration</code> must have * a unique DisplayName and must have non-null values for DisplayName, * ClassImpl, OfficeMime, and DeviceMime. * - * @param ciVectory A <code>Vector</code> of <code>ConverterInfo</code> + * @param jarEnum An <code>Enumeration</code> of <code>ConverterInfo</code> * objects describing one or more plug-in(s). * * @throws RegistryException If a <code>ConverterInfo</code> in the - * <code>Vector</code> is not valid. + * <code>Enumeration</code> is not valid. */ public static void addPlugIn(Enumeration jarEnum) throws RegistryException { @@ -257,8 +257,8 @@ public final class ConverterInfoMgr { * If there are multiple <code>ConverterInfo</code> objects that * support this conversion, only the first is returned. * - * @param deviceMimeFrom The device from mime. - * @param deviceMimeTo The device to mime. + * @param deviceFromMime The device from mime. + * @param deviceToMime The device to mime. * * @return An array of two <code>ConverterInfo</code> objects * that can be chained to perform the specified |