From e1bf8fff0dfcdc3c6e67c18a4e4c7da97f6e2984 Mon Sep 17 00:00:00 2001 From: rbuj Date: Fri, 29 Aug 2014 13:33:01 +0200 Subject: xmerge: fix javadoc errors for JDK 8 Change-Id: Ic8352b7460c36155215d25339650ede40735e65d Reviewed-on: https://gerrit.libreoffice.org/11189 Reviewed-by: Noel Grandin Tested-by: Noel Grandin --- .../openoffice/xmerge/converter/palm/PalmDB.java | 4 +- .../xmerge/converter/palm/PdbDecoder.java | 18 ++++----- .../xmerge/converter/palm/PdbEncoder.java | 14 +++---- .../openoffice/xmerge/converter/xml/ParaStyle.java | 39 +++++++++--------- .../converter/xml/sxc/DocumentMergerImpl.java | 4 +- .../converter/xml/xslt/DocumentMergerImpl.java | 2 +- .../xmerge/merger/diff/IteratorRowCompare.java | 46 ++++++++++++---------- .../openoffice/xmerge/merger/merge/SheetUtil.java | 17 ++++---- .../java/org/openoffice/xmerge/util/Debug.java | 2 +- 9 files changed, 76 insertions(+), 70 deletions(-) (limited to 'xmerge/source') diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDB.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDB.java index a96400aed222..643cd64bcdd7 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDB.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PalmDB.java @@ -44,12 +44,12 @@ import java.io.UnsupportedEncodingException; * bName, and a corresponding String object sName * that contains characters without the '\0' characters.

* - *

The {@link #write write} method is called within the + *

The write method is called within the * {@link org.openoffice.xmerge.converter.palm.PalmDocument#write * PalmDocument.write} method for writing out its data to the OutputStream * object.

* - *

The {@link #read read} method is called within the + *

The read method is called within the * {@link org.openoffice.xmerge.converter.palm.PalmDocument#read * PalmDocument.read} method for reading in its data from the InputStream * object.

diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbDecoder.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbDecoder.java index c62837c5879e..02143e789cb5 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbDecoder.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbDecoder.java @@ -36,15 +36,15 @@ import java.io.DataInputStream; * *

This decoder has the following assumptions on the PDB file:

* - *

    - *
  1. There is only one RecordList section in the PDB.
    2. - *
  2. The Record indices in the RecordList are sorted in - * order, i.e. the first Record index refers to - * Record 0, and so forth.
    3. - *
  3. The raw Record in the Record section - * are sorted as well in order, i.e. first Record - * comes ahead of second Record, etc.
    4. - *

+ *
    + *
  1. There is only one RecordList section in the PDB.
    2. + *
  2. The Record indices in the RecordList are sorted in + * order, i.e. the first Record index refers to + * Record 0, and so forth.
    3. + *
  3. The raw Record in the Record section + * are sorted as well in order, i.e. first Record + * comes ahead of second Record, etc.
    4. + *
* *

Other decoders assume these as well.

* 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 cdd866fb250a..83f8a27f423d 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 @@ -86,7 +86,7 @@ public final class PdbEncoder { /** - *

Write out a PDB into the given OutputStream.

+ * Write out a PDB into the given OutputStream. * *

First, write out the header data by using the * PdbHeader write method. Next, @@ -98,12 +98,12 @@ public final class PdbEncoder { * Record index info, where each Record * index info contains:

* - *

    - *
  • 4 bytes local offset of the Record from the - * top of the PDB.
    • - *
  • 1 byte of Record attribute.
    • - *
  • 3 bytes unique Record ID.
    • - *

+ *
    + *
  • 4 bytes local offset of the Record from the + * top of the PDB.
    • + *
  • 1 byte of Record attribute.
    • + *
  • 3 bytes unique Record ID.
    • + *
* *

There should be a total of header.numRecords * of Record index info

. 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 28c964c22452..8cafc8c985d3 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 @@ -117,28 +117,25 @@ class alignment extends conversionAlgorithm { /** - *

This class represents a paragraph Style.

+ * This class represents a paragraph Style. * - *

- * Attribute Value - *
- * MARGIN_LEFT mm * 100 - *
- * MARGIN_RIGHT mm * 100 - *
- * MARGIN_TOP mm * 100 (space on top of paragraph) - *
- * MARGIN_BOTTOM mm * 100 - *
- * TEXT_INDENT mm * 100 (first line indent) - *
- * LINE_HEIGHT mm * 100, unless or'ed with LH_PCT, in which - * case it is a percentage (e.g. 200% for double spacing) - * Can also be or'ed with LH_ATLEAST. Value is stored - * in bits indicated by LH_VALUEMASK. - *
- * TEXT_ALIGN ALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUST, ALIGN_LEFT - *

+ * + * + * + * + * + * + * + * + * + * + * + * + * + *
Table with all paragraph style attributes and their values
AttributeValue
MARGIN_LEFTmm * 100
MARGIN_RIGHTmm * 100
MARGIN_TOPmm * 100 (space on top of paragraph)
MARGIN_BOTTOMmm * 100
TEXT_INDENTmm * 100 (first line indent)
LINE_HEIGHTmm * 100, unless or'ed with LH_PCT, in which + * case it is a percentage (e.g. 200% for double spacing) + * Can also be or'ed with LH_ATLEAST. Value is stored + * in bits indicated by LH_VALUEMASK.
TEXT_ALIGNALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUST, ALIGN_LEFT
*/ public class ParaStyle extends Style implements Cloneable { 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 fd01ec88111c..ef427c8bc35c 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 @@ -44,7 +44,9 @@ import org.openoffice.xmerge.util.Debug; * Generic small device implementation of DocumentMerger for * the {@link * org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory - * SxcPluginFactory}. Used with SXC Document objects.

+ * SxcPluginFactory}. + * + *

Used with SXC Document objects.

*/ public class DocumentMergerImpl implements DocumentMerger { 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 5275b809438f..da0f71e4f4d1 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 @@ -38,7 +38,7 @@ import org.openoffice.xmerge.util.Debug; * Xslt implementation of DocumentMerger * for the {@link * org.openoffice.xmerge.converter.xml.xslt.PluginFactoryImpl - * PluginFactoryImpl}.

+ * PluginFactoryImpl}. */ public class DocumentMergerImpl implements DocumentMerger { 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 94d4112de75b..746709840e28 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 @@ -28,28 +28,32 @@ import org.openoffice.xmerge.merger.Iterator; import org.openoffice.xmerge.converter.xml.OfficeConstants; /** - *

A very simple and direct difference algorithm for row - * Node objects in a spreadsheet. Basically, it will - * compare objects in sequence and does not look ahead (unlike LCS).

+ * A very simple and direct difference algorithm for row + * Node objects in a spreadsheet. * - *

  1. - * If two objects are the same, skip to next one. - *
  2. - * Otherwise check whether the row repeated attribute is the same. - *
  3. - * If the row repeated attribute is the same, then compare two rows - * and mark it as change if those rows are different. - *
  4. - * If the row repeated attribute is different, then split the rows and - * continue to compare. - *
  5. - * If there are more objects in the modseq than the original sequence, - * then all of the extra ones in the modified sequence are marked as add. - *
  6. - * 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. - *

+ *

Basically, it will compare objects in sequence and does not look ahead + * (unlike LCS).

+ * + *
    + *
  1. + * If two objects are the same, skip to next one. + *
  2. + * Otherwise check whether the row repeated attribute is the same. + *
  3. + * If the row repeated attribute is the same, then compare two rows + * and mark it as change if those rows are different. + *
  4. + * If the row repeated attribute is different, then split the rows and + * continue to compare. + *
  5. + * If there are more objects in the modseq than the original sequence, + * then all of the extra ones in the modified sequence are marked as add. + *
  6. + * 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. + *
    7. + *
* *

NOTE: The algorithm will have potential side effect to split rows.

*/ 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 d6c872e506d9..cbad7ccfdb61 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 @@ -33,14 +33,17 @@ import org.openoffice.xmerge.converter.xml.OfficeConstants; public class SheetUtil { /** - *

Empty the content of a cell value. This includes the following: - *

+ * Empty the content of a cell value. * - *

  • - * Remove all of the supported attributes. - *
  • - * Remove the first text:p Node for most of the cells. - *

+ *

This includes the following:

+ * + *
    + *
  • + * Remove all of the supported attributes. + *
  • + * Remove the first text:p Node for most of the cells. + *
    • + *
* * @param cc The ConverterCapabilities. * @param node The Node. 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 7e13cd678792..e4a7276ece24 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/Debug.java @@ -31,7 +31,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 System.out, * System.err, or to a file. -- cgit v1.2.3