xmerge: fix javadoc errors for JDK 8

Change-Id: Ic8352b7460c36155215d25339650ede40735e65d
Reviewed-on: https://gerrit.libreoffice.org/11189
Reviewed-by: Noel Grandin <noelgrandin@gmail.com>
Tested-by: Noel Grandin <noelgrandin@gmail.com>
This commit is contained in:
rbuj 2014-08-29 13:33:01 +02:00 committed by Noel Grandin
parent 2602a41f76
commit e1bf8fff0d
9 changed files with 76 additions and 70 deletions

View File

@ -44,12 +44,12 @@ import java.io.UnsupportedEncodingException;
* <code>bName</code>, and a corresponding String object <code>sName</code>
* that contains characters without the '\0' characters.</p>
*
* <p>The {@link #write write} method is called within the
* <p>The <code>write</code> method is called within the
* {@link org.openoffice.xmerge.converter.palm.PalmDocument#write
* PalmDocument.write} method for writing out its data to the <code>OutputStream</code>
* object.</p>
*
* <p>The {@link #read read} method is called within the
* <p>The <code>read</code> method is called within the
* {@link org.openoffice.xmerge.converter.palm.PalmDocument#read
* PalmDocument.read} method for reading in its data from the <code>InputStream</code>
* object.</p>

View File

@ -36,15 +36,15 @@ import java.io.DataInputStream;
*
* <p>This decoder has the following assumptions on the PDB file:</p>
*
* <p><ol>
* <li>There is only one RecordList section in the PDB.</li>
* <li>The <code>Record</code> indices in the RecordList are sorted in
* order, i.e. the first <code>Record</code> index refers to
* <code>Record</code> 0, and so forth.</li>
* <li>The raw <code>Record</code> in the <code>Record</code> section
* are sorted as well in order, i.e. first <code>Record</code>
* comes ahead of second <code>Record</code>, etc.</li>
* </ol></p>
* <ol>
* <li>There is only one RecordList section in the PDB.</li>
* <li>The <code>Record</code> indices in the RecordList are sorted in
* order, i.e. the first <code>Record</code> index refers to
* <code>Record</code> 0, and so forth.</li>
* <li>The raw <code>Record</code> in the <code>Record</code> section
* are sorted as well in order, i.e. first <code>Record</code>
* comes ahead of second <code>Record</code>, etc.</li>
* </ol>
*
* <p>Other decoders assume these as well.</p>
*

View File

@ -86,7 +86,7 @@ public final class PdbEncoder {
/**
* <p>Write out a PDB into the given <code>OutputStream</code>.</p>
* Write out a PDB into the given <code>OutputStream</code>.
*
* <p>First, write out the header data by using the
* <code>PdbHeader</code> <code>write</code> method. Next,
@ -98,12 +98,12 @@ public final class PdbEncoder {
* <code>Record</code> index info, where each <code>Record</code>
* index info contains:</p>
*
* <p><ul>
* <li>4 bytes local offset of the <code>Record</code> from the
* 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>
* <li>4 bytes local offset of the <code>Record</code> from the
* 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>There should be a total of <code>header.numRecords</code>
* of <code>Record</code> index info</p>.

View File

@ -117,28 +117,25 @@ class alignment extends conversionAlgorithm {
/**
* <p>This class represents a paragraph <code>Style</code>.</p>
* This class represents a paragraph <code>Style</code>.
*
* <p><table border="1" cellpadding="1"><tr><td>
* Attribute </td><td>Value
* </td></tr><tr><td>
* MARGIN_LEFT </td><td>mm * 100
* </td></tr><tr><td>
* MARGIN_RIGHT </td><td>mm * 100
* </td></tr><tr><td>
* MARGIN_TOP </td><td>mm * 100 (space on top of paragraph)
* </td></tr><tr><td>
* MARGIN_BOTTOM </td><td>mm * 100
* </td></tr><tr><td>
* TEXT_INDENT </td><td>mm * 100 (first line indent)
* </td></tr><tr><td>
* LINE_HEIGHT </td><td>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.
* </td></tr><tr><td>
* TEXT_ALIGN </td><td>ALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUST, ALIGN_LEFT
* </td></tr></table></p>
* <table summary="Paragraph style attributes and their values" border="1" cellpadding="1">
* <caption>Table with all paragraph style attributes and their values</caption>
* <tr><td>Attribute</td><td>Value</td></tr>
* <tr><td>MARGIN_LEFT</td><td>mm * 100</td></tr>
* <tr><td>MARGIN_RIGHT</td><td>mm * 100</td></tr>
* <tr><td>MARGIN_TOP</td><td>mm * 100 (space on top of paragraph)</td></tr>
* <tr><td>MARGIN_BOTTOM</td><td>mm * 100</td></tr>
* <tr><td>TEXT_INDENT</td><td>mm * 100 (first line indent)</td></tr>
* <tr>
* <td>LINE_HEIGHT</td>
* <td>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.</td>
* </tr>
* <tr><td>TEXT_ALIGN</td><td>ALIGN_RIGHT, ALIGN_CENTER, ALIGN_JUST, ALIGN_LEFT</td></tr>
* </table>
*/
public class ParaStyle extends Style implements Cloneable {

View File

@ -44,7 +44,9 @@ 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}.
*
* <p>Used with SXC <code>Document</code> objects.</p>
*/
public class DocumentMergerImpl implements DocumentMerger {

View File

@ -38,7 +38,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 {

View File

@ -28,28 +28,32 @@ import org.openoffice.xmerge.merger.Iterator;
import org.openoffice.xmerge.converter.xml.OfficeConstants;
/**
* <p>A very simple and direct difference algorithm for row
* <code>Node</code> objects in a spreadsheet. Basically, it will
* compare objects in sequence and does not look ahead (unlike LCS).</p>
* A very simple and direct difference algorithm for row
* <code>Node</code> objects in a spreadsheet.
*
* <p><ol><li>
* If two objects are the same, skip to next one.
* </li><li>
* Otherwise check whether the row repeated attribute is the same.
* </li><li>
* If the row repeated attribute is the same, then compare two rows
* and mark it as <i>change</i> if those rows are different.
* </li><li>
* If the row repeated attribute is different, then split the rows and
* continue to compare.
* </li><li>
* 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.
* </li><li>
* 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>
* <p>Basically, it will compare objects in sequence and does not look ahead
* (unlike LCS).</p>
*
* <ol>
* <li>
* If two objects are the same, skip to next one.
* </li><li>
* Otherwise check whether the row repeated attribute is the same.
* </li><li>
* If the row repeated attribute is the same, then compare two rows
* and mark it as <i>change</i> if those rows are different.
* </li><li>
* If the row repeated attribute is different, then split the rows and
* continue to compare.
* </li><li>
* 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.
* </li><li>
* 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>NOTE: The algorithm will have potential side effect to split rows.</p>
*/

View File

@ -33,14 +33,17 @@ import org.openoffice.xmerge.converter.xml.OfficeConstants;
public class SheetUtil {
/**
* <p>Empty the content of a cell value. This includes the following:
* </p>
* Empty the content of a cell value.
*
* <p><ul><li>
* 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>
* <p>This includes the following:</p>
*
* <ul>
* <li>
* 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>
*
* @param cc The <code>ConverterCapabilities</code>.
* @param node The <code>Node</code>.

View File

@ -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} &amp; {@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.