mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Java update - fix various javadoc issues

Browse Source 
Along the way, remove some javadoc comments that are completely incorrect.

Change-Id: I02f96b6cbe665d2c10bd6ee245a7d8e2eef0f755
This commit is contained in:
Noel Grandin 2012-08-20 12:54:24 +01:00 committed by Caolán McNamara
parent af4ca5a8c6
commit f6a62d9e41
55 changed files with 75 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
accessibility/bridge/org/openoffice/java/accessibility/Frame.java
View File

@ -467,7 +467,7 @@ public class Frame extends java.awt.Frame implements javax.accessibility.Accessi
*
* @return an instance of AccessibleState containing the current state
* of the object
* @see AccessibleState
* @see javax.accessibility.AccessibleState
*/
public javax.accessibility.AccessibleStateSet getAccessibleStateSet() {
javax.accessibility.AccessibleStateSet states = super.getAccessibleStateSet();

2
accessibility/bridge/org/openoffice/java/accessibility/MenuItem.java
View File

@ -71,7 +71,7 @@ class MenuItem extends ToggleButton {
*
* @return an instance of <code>AccessibleStateSet</code>
* containing the current state set of the object
* @see AccessibleState
* @see javax.accessibility.AccessibleState
*/
public javax.accessibility.AccessibleStateSet getAccessibleStateSet() {
javax.accessibility.AccessibleStateSet stateSet = super.getAccessibleStateSet();

2
bean/com/sun/star/comp/beans/OOoBean.java
View File

@ -1062,7 +1062,7 @@ xLayoutManager.showElement("private:resource/menubar/menubar");
/** Helper method to set tool bar visibilty.
@param bnewValue
@param bNewValue
If false, the tool bar is disabled,
If true, the tool bar is visible.

12
connectivity/com/sun/star/sdbcx/comp/hsqldb/StorageNativeOutputStream.java
View File

@ -67,7 +67,7 @@ public class StorageNativeOutputStream {
* @param b the data.
* @param off the start offset in the data.
* @param len the number of bytes to write.
* @exception IOException if an I/O error occurs. In particular,
* @exception java.io.IOException if an I/O error occurs. In particular,
* an <code>IOException</code> is thrown if the output
* stream is closed.
*/
@ -80,7 +80,7 @@ public class StorageNativeOutputStream {
* <code>write(b, 0, b.length)</code>.
*
* @param b the data.
* @exception IOException if an I/O error occurs.
* @exception java.io.IOException if an I/O error occurs.
* @see java.io.OutputStream#write(byte[], int, int)
*/
public native void write(String key,String _file,byte[] b) throws java.io.IOException;
@ -95,7 +95,7 @@ public class StorageNativeOutputStream {
* @param key The name of the data source.
* @param _file The name of the file to write to.
*
* @exception IOException if an I/O error occurs.
* @exception java.io.IOException if an I/O error occurs.
*/
public native void close(String key,String _file) throws java.io.IOException;
@ -112,7 +112,7 @@ public class StorageNativeOutputStream {
* @param key The name of the data source.
* @param _file The name of the file to write to.
* @param b the <code>byte</code>.
* @exception IOException if an I/O error occurs. In particular,
* @exception java.io.IOException if an I/O error occurs. In particular,
* an <code>IOException</code> may be thrown if the
* output stream has been closed.
*/
@ -130,7 +130,7 @@ public class StorageNativeOutputStream {
* @param key The name of the data source.
* @param _file The name of the file to write to.
*
* @exception IOException if an I/O error occurs.
* @exception java.io.IOException if an I/O error occurs.
*/
public native void flush(String key,String _file) throws java.io.IOException;
@ -151,7 +151,7 @@ public class StorageNativeOutputStream {
* be flushed (for example, by invoking
* OutputStream.flush) before that data will be affected by sync.
*
* @exception IOException
* @exception java.io.IOException
* Thrown when the buffers cannot be flushed,
* or because the system cannot guarantee that all the
* buffers have been synchronized with physical media.

2
connectivity/qa/connectivity/tools/CRMDatabase.java
View File

@ -83,7 +83,7 @@ public class CRMDatabase
* creates a CRMDatabase from an existing document, given by URL
* @param _orb
* @param _existingDocumentURL
* @throws Exceptio
* @throws Exception
*/
public CRMDatabase( XMultiServiceFactory _orb, final String _existingDocumentURL ) throws Exception
{

2
filter/qa/complex/filter/detection/typeDetection/Helper.java
View File

@ -304,7 +304,7 @@ public class Helper {
* @param propNames String Array of propertie names
* @param values Objecr Array of propertie values
* @return <code>PropertyValue[]<code>
* @see com.sun.star.benas.PropertyValue
* @see com.sun.star.beans.PropertyValue
* @see com.sun.star.document.MediaDescriptor
*/
public PropertyValue[] createMediaDescriptor(String[] propNames, Object[] values) {

3
filter/source/xsltfilter/com/sun/star/comp/xsltfilter/Base64.java
View File

@ -706,8 +706,7 @@ public class Base64
* @param source The data to convert
* @param off Offset in array where conversion should begin
* @param len Length of data to convert
* @param options Specified options
* @param options alphabet type is pulled from this (standard, url-safe, ordered)
* @param options Specified options, alphabet type is pulled from this (standard, url-safe, ordered)
* @see Base64#GZIP
* @see Base64#DONT_BREAK_LINES
* @since 2.0

5
framework/qa/complex/XUserInputInterception/EventTest.java
View File

@ -309,7 +309,7 @@ public class EventTest {
* <CODE>m_keyReleased</CODE> are <CODE>TRUE</CODE>
* @param xUII the XUserInputInterception
* @param xModel the XModel of a document
* @see EventTest.MyKeyHander
* @see EventTest.MyKeyHandler
* @see EventTest.EventTrigger
*/
private void checkKeyListener(XUserInputInterception xUII, XModel xModel) {
@ -341,10 +341,9 @@ public class EventTest {
* <CODE>m_mouseReleased</CODE> are <CODE>TRUE</CODE>
* @param xUII the XUserInputInterception
* @param xModel the XModel of a document
* @see EventTest.MyMouseClickHander
* @see EventTest.MyMouseClickHandler
* @see EventTest.EventTrigger
*/
private void checkMouseListener(XUserInputInterception xUII, XModel xModel) {
m_mousePressed = false;

8
framework/qa/complex/framework/autosave/Protocol.java
View File

@ -526,7 +526,7 @@ public class Protocol extends JComponent
* @param sMessage
* the pure message
*
* @see log(type,message)
* @see #log(int, String)
*/
public synchronized void log( /*IN*/ String sMessage )
{
@ -756,8 +756,8 @@ public class Protocol extends JComponent
*
* @return A string, which includes the whole header.
*
* @see finish()
* @see generateHTMLFooter()
* @see #finish()
* @see #impl_generateHTMLFooter()
*/
private String impl_generateHTMLHeader()
{
@ -786,7 +786,7 @@ public class Protocol extends JComponent
* @param sOut
* used to generate the log output there.
*
* @param lProps/aProp
* @param lProps
* represent the property(array) to be logged.
*/
private void impl_logPropertyArray( /*OUT*/ StringBuffer sOut ,

4
framework/qa/complex/framework/recovery/RecoveryTest.java
View File

@ -539,8 +539,8 @@ public class RecoveryTest extends ComplexTestCase {
/**
* This function uses accessibility to handle the dialog "Are you sure".
* It cklick "Yes" or "No", dependend on the value of the parameter <CODE>Yes</CODE>
* @param yes If value is <CODE>TRUE</CODE> the button "Yes" was clicked, otherwise the button
* It click "Yes" or "No", depending on the value of the parameter <CODE>Yes</CODE>
* @param saveDocuments If value is <CODE>TRUE</CODE> the button "Yes" was clicked, otherwise the button
* "No".
*/
private void handleSaveDocumentsDialog(boolean saveDocuments)

1
framework/qa/complex/framework/recovery/RecoveryTools.java
View File

@ -141,7 +141,6 @@ public class RecoveryTools {
/**
* remove the content of the user backup folder and removes the Recovery.xcu. This
* was done from the Office via XSimpleFileAccess
* @param xMSF a <CODE>XMultiServiceFactory</CODE> to get <CODE>XSimpleFileAccess</CODE>
* @throws com.sun.star.io.IOException the exception was thrown if something goes wrong.
*/
public void cleanRecoveryData()

2
javaunohelper/com/sun/star/lib/uno/helper/InterfaceContainer.java
View File

@ -96,8 +96,6 @@ public class InterfaceContainer implements Cloneable
/**
* The size of the ArrayList (the number of elements it contains).
*
* @serial
*/
private int size;

4
javaunohelper/com/sun/star/lib/uno/helper/WeakAdapter.java
View File

@ -74,6 +74,7 @@ public class WeakAdapter implements XAdapter
{
return m_weakRef.get();
}
/** Method of com.sun.star.uno.XAdapter. Called by clients to register listener which
* are notified when the weak object is dying.
*@param xReference a listener
@ -82,8 +83,9 @@ public class WeakAdapter implements XAdapter
{
m_xreferenceList.remove(xReference);
}
/** Method of com.sun.star.uno.XAdapter. Called by clients to unregister listeners.
*@param a listener
*@param xReference listener
*/
public void addReference(XReference xReference)
{

2
jurt/com/sun/star/comp/connections/Acceptor.java
View File

@ -37,7 +37,7 @@ import com.sun.star.registry.XRegistryKey;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/comp/connections/Connector.java
View File

@ -37,7 +37,7 @@ import com.sun.star.registry.XRegistryKey;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/comp/connections/ConstantInstanceProvider.java
View File

@ -36,7 +36,7 @@ import com.sun.star.comp.loader.FactoryHelper;
* @see com.sun.star.bridge.XBridge
* @see com.sun.star.bridge.XBridgeFactory
* @see com.sun.star.bridge.XInstanceProvider
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
* @since UDK1.0
*/
public class ConstantInstanceProvider implements XInstanceProvider {

2
jurt/com/sun/star/comp/connections/PipedConnection.java
View File

@ -36,7 +36,7 @@ import com.sun.star.registry.XRegistryKey;
* <p>
* @author Kay Ramme
* @see com.sun.star.connection.XConnection
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
* @since UDK1.0
*/
public class PipedConnection implements XConnection {

2
jurt/com/sun/star/lib/connections/pipe/pipeAcceptor.java
View File

@ -37,7 +37,7 @@ import com.sun.star.registry.XRegistryKey;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/lib/connections/pipe/pipeConnector.java
View File

@ -37,7 +37,7 @@ import com.sun.star.registry.XRegistryKey;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/lib/connections/socket/socketAcceptor.java
View File

@ -41,7 +41,7 @@ import java.net.Socket;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection2
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/lib/connections/socket/socketConnector.java
View File

@ -41,7 +41,7 @@ import java.net.UnknownHostException;
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.loader.JavaLoader
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/

2
jurt/com/sun/star/lib/uno/environments/remote/Job.java
View File

@ -37,7 +37,7 @@ import com.sun.star.uno.XCurrentContext;
* remotely because of a method invocation.
* <p>
* @author Kay Ramme
* @see com.sun.star.lib.uno.environments.remote.ThreadID
* @see com.sun.star.lib.uno.environments.remote.ThreadId
* @see com.sun.star.lib.uno.environments.remote.IReceiver
* @since UDK1.0
*/

8
jurt/com/sun/star/lib/uno/environments/remote/JobQueue.java
View File

@ -32,7 +32,7 @@ import com.sun.star.lang.DisposedException;
* @author Kay Ramme
* @see com.sun.star.lib.uno.environments.remote.ThreadPool
* @see com.sun.star.lib.uno.environments.remote.Job
* @see com.sun.star.lib.uno.environments.remote.ThreadID
* @see com.sun.star.lib.uno.environments.remote.ThreadId
* @since UDK1.0
*/
public class JobQueue {
@ -112,7 +112,7 @@ public class JobQueue {
* which belongs to the given sync job queue.
* <p>
* @param threadId the thread id
* @see com.sun.star.lib.uno.environments.remote.ThreadID
* @see com.sun.star.lib.uno.environments.remote.ThreadId
*/
JobQueue(JavaThreadPoolFactory javaThreadPoolFactory, ThreadId threadId) {
_javaThreadPoolFactory = javaThreadPoolFactory;
@ -139,7 +139,7 @@ public class JobQueue {
* <p>
* @param threadId the thread id
* @param createThread if true, the queue creates a worker thread if needed
* @see com.sun.star.lib.uno.environments.remote.ThreadID
* @see com.sun.star.lib.uno.environments.remote.ThreadId
*/
JobQueue(JavaThreadPoolFactory javaThreadPoolFactory, ThreadId threadId, boolean createThread){
_javaThreadPoolFactory = javaThreadPoolFactory;
@ -154,7 +154,7 @@ public class JobQueue {
* Gives the thread id of this queue
* <p>
* @return the thread id
* @see com.sun.star.lib.uno.environments.remote.ThreadID
* @see com.sun.star.lib.uno.environments.remote.ThreadId
*/
ThreadId getThreadId() {
return _threadId;

2
ridljar/com/sun/star/uno/UnoRuntime.java
View File

@ -160,7 +160,7 @@ public class UnoRuntime {
* Queries the given UNO object for the given Java class (which must
* represent a UNO interface type).
*
* @param ifc a Java class representing a UNO interface type
* @param zInterface a Java class representing a UNO interface type
* @param object a reference to any Java object representing (a facet of) a
* UNO object; may be <code>null</code>
* @return a reference to the requested UNO interface type if available,

11
scripting/java/com/sun/star/script/framework/container/ParcelContainer.java
View File

@ -217,11 +217,9 @@ public class ParcelContainer implements XNameAccess
* @param xCtx UNO component context
* @param containerUrl location of this container.
* @param language language for which entries are stored
* @return name of <tt>ParcelContainer</tt>
* @throws IllegalArgumentException
* @throws com.sun.star.lang.IllegalArgumentException
* @throws WrappedTargetException
*/
public ParcelContainer( XComponentContext xCtx, String containerUrl, String language ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
{
@ -235,8 +233,7 @@ public class ParcelContainer implements XNameAccess
* @param language language for which entries are stored
* @param loadParcels set to <tt>true</tt> if parcels are to be loaded
* on construction.
* @return name of <tt>ParcelContainer</tt>
* @throws IllegalArgumentException
* @throws com.sun.star.lang.IllegalArgumentException
* @throws WrappedTargetException
*/
public ParcelContainer( XComponentContext xCtx, String containerUrl, String language, boolean loadParcels ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
@ -252,10 +249,8 @@ public class ParcelContainer implements XNameAccess
* @param language language for which entries are stored
* @param loadParcels set to <tt>true</tt> if parcels are to be loaded
* on construction.
* @return name of <tt>ParcelContainer</tt>
* @throws IllegalArgumentException
* @throws com.sun.star.lang.IllegalArgumentException
*/
public ParcelContainer( ParcelContainer parent, XComponentContext xCtx, String containerUrl, String language, boolean loadParcels ) throws com.sun.star.lang.IllegalArgumentException, com.sun.star.lang.WrappedTargetException
{

3
scripting/java/com/sun/star/script/framework/provider/beanshell/ScriptEditorForBeanShell.java
View File

@ -184,9 +184,8 @@ public class ScriptEditorForBeanShell
* If an editor window is already open for that data it will be
* moved to the front.
*
* @param metadata The metadata describing the script
* @param context The context in which to execute the script
*
* @param entry The metadata describing the script
*/
public void edit(final XScriptContext context, ScriptMetaData entry) {
if (entry != null ) {

4
scripting/java/com/sun/star/script/framework/provider/java/ScriptProviderForJava.java
View File

@ -165,7 +165,7 @@ class ScriptImpl implements XScript
* Invoke
*
*
* @param aParams All parameters; pure, out params are undefined in
* @param params All parameters; pure, out params are undefined in
* sequence, i.e., the value has to be ignored by the callee
* @param aOutParamIndex Out indices
* @param aOutParam Out parameters
@ -173,7 +173,7 @@ class ScriptImpl implements XScript
* @throws IllegalArgumentException If there is no matching script name
* @throws CannotConvertException If args do not match or cannot be converted
* the those of the invokee
* @throws InvocationTargetException If the running script throws an exception
* @throws com.sun.star.reflection.InvocationTargetException If the running script throws an exception
* this information is captured and rethrown as this exception type.
*/

3
scripting/java/com/sun/star/script/framework/provider/javascript/ScriptEditorForJavaScript.java
View File

@ -167,9 +167,8 @@ public class ScriptEditorForJavaScript implements ScriptEditor
* If an editor window is already open for that data it will be
* moved to the front.
*
* @param metadata The metadata describing the script
* @param context The context in which to execute the script
*
* @param entry The metadata describing the script
*/
public void edit(final XScriptContext context, ScriptMetaData entry)
{

2
scripting/java/com/sun/star/script/framework/provider/javascript/ScriptProviderForJavaScript.java
View File

@ -149,7 +149,7 @@ class ScriptImpl implements XScript
*
*
*
* @param aParams All parameters; pure, out params are
* @param params All parameters; pure, out params are
* undefined in sequence, i.e., the value
* has to be ignored by the callee
*

3
sfx2/qa/complex/sfx2/UndoManager.java
View File

@ -298,8 +298,7 @@ public class UndoManager
// -----------------------------------------------------------------------------------------------------------------
/**
* returns the undo manager belonging to a given document
* @return
* @return returns the undo manager belonging to a given document
*/
private XUndoManager getUndoManager()
{

4
sfx2/qa/complex/sfx2/undo/DocumentTest.java
View File

@ -63,8 +63,8 @@ public interface DocumentTest
/**
* does multiple modifications do the document, which would normally result in multiple Undo actions.
*
* The test framework will encapsulate the call into an {@link XUndoManager.enterUndoContext()} and
* {@link XUndoManager.leaveUndoContext()} call.
* The test framework will encapsulate the call into an {@link com.sun.star.document.XUndoManager#enterUndoContext} and
* {@link com.sun.star.document.XUndoManager#leaveUndoContext} call.
*
* @return
* the number of modifications done to the document. The caller assumes (and asserts) that the number

7
xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocDecoder.java
View File

@ -27,8 +27,7 @@ import org.openoffice.xmerge.util.Resources;
import org.openoffice.xmerge.util.Debug;
/**
* This class is used by {@link
* org.openoffice.xmerge.converter.xml.sxw.DocumentDeserializerImpl}
* This class is used by {@link DocumentDeserializerImpl}
* to decode the AportisDoc format. It currently decodes
* the text content into a single <code>String</code> object.
*
@ -56,7 +55,7 @@ final class DocDecoder implements DocConstants {
* Decode the text records into a single <code>String</code>
* of text content.
*
* @param Record <code>Record</code> array holding AportisDoc
* @param recs <code>Record</code> array holding AportisDoc
* contents.
*
* @throws IOException If any I/O error occurs.
@ -114,7 +113,7 @@ final class DocDecoder implements DocConstants {
* with the encoding of that PDB and throw
* <code>IOException</code>.</p>
*
* @param bytes Compressed <code>byte</code> array.
* @param cBytes Compressed <code>byte</code> array.
* @param textRecordSize Size of uncompressed
* <code>byte</code> array.
*

4
xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocEncoder.java
View File

@ -27,9 +27,7 @@ import java.util.ArrayList;
import org.openoffice.xmerge.converter.palm.Record;
/**
* This class is used by {@link
* org.openoffice.xmerge.converter.xml.sxw.DocumentSerializerImpl
* DocumentSerializerImpl} to encode the AportisDoc format.
* This class is used by {@link DocumentSerializerImpl} to encode the AportisDoc format.
* It does not deal with any XML tags. It only knows how to encode
* from <code>String</code>.
*

5
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
View File

@ -45,8 +45,7 @@ import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Worksheet;
import org.openoffice.xmerge.util.Debug;
/**
* This class is used by {@link
* org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializerImpl}
* This class is used by {@link SxcDocumentDeserializerImpl}
* SxcDocumentDeserializerImpl} to decode the Pocket Excel format.
*
* @author Paul Rank
@ -84,7 +83,7 @@ final class PocketExcelDecoder extends SpreadsheetDecoder {
* converts it into a PocketWord WorkSheet. The WorkSheet is then
* added to the WorkBook.
*
* @param InputStream An <code>ConvertData</code> containing a
* @param cd An <code>ConvertData</code> containing a
* Pocket Excel WorkSheet.
*
* @throws IOException If any I/O error occurs.

19
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
View File

@ -31,9 +31,7 @@ import org.openoffice.xmerge.converter.xml.sxc.NameDefinition;
import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Workbook;
/**
* This class is used by {@link
* org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializerImpl
* SxcDocumentSerializerImpl} to encode the Pocket Excel format.
* This class is used by {@link SxcDocumentSerializerImpl} to encode the Pocket Excel format.
*
* @author Martin Maher
*/
@ -200,20 +198,13 @@ final class PocketExcelEncoder extends SpreadsheetEncoder {
/**
* Set the width of the columns in the WorkBook.
*
* @param columnWidths An <code>IntArrayList</code> of column
* widths.
* @param columnRows An <code>ArrayList</code> of ColumnRowInfo
*/
public void setColumnRows(ArrayList<ColumnRowInfo> columnRows) throws IOException {
wb.addColInfo(columnRows);
}
/**
* Set the width of the columns in the WorkBook.
*
* @param columnWidths An <code>IntArrayList</code> of column
* widths.
*/
public void setNameDefinition(NameDefinition nd) throws IOException {
String parsedName = nd.getDefinition();
@ -222,12 +213,6 @@ final class PocketExcelEncoder extends SpreadsheetEncoder {
wb.addNameDefinition(nd);
}
/**
* Set the width of the columns in the WorkBook.
*
* @param columnWidths An <code>IntArrayList</code> of column
* widths.
*/
public void addSettings(BookSettings s) throws IOException {
wb.addSettings(s);

2
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java
View File

@ -59,7 +59,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();

2
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
View File

@ -118,8 +118,6 @@ public class LabelCell extends CellValue {
/**
* Sets the <code>String</code> representing the cells contents
*
* @return the <code>String</code> representing the cells contents
*/
private void setLabel(String cellContents) throws IOException {
rgch = cellContents.getBytes("UTF-16LE");

2
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java
View File

@ -128,7 +128,7 @@ public class FormulaParser {
/**
* 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) {

4
xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java
View File

@ -279,7 +279,7 @@ public class TokenEncoder {
/**
* A Cell Reference Encoder (It supports absolute and relative addressing)
*
* @param t <code>Token</code> to be encoded
* @param cellCoordinates <code>Token</code> to be encoded
* @return A <code>Vector</code> of pexcel <code>Byte</code>
*/
private byte[] encodeCellCoordinates(String cellCoordinates) {
@ -362,7 +362,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 <code>Token</code> to be encoded
* @return A <code>Vector</code> of pexcel <code>Byte</code>
*/
private short findSheetIndex(String s) {

2
xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java
View File

@ -125,8 +125,6 @@ public final class DocumentDeserializerImpl
*
* @param data An Enumeration of all Paragraphs in the Pocket Word doc.
*
* @return The OpenOffice Writer XML representation of the data.
*
* @throws IOException If any I/O errors occur.
*/
private void buildDocument(Iterator<Paragraph> data) throws IOException {

2
xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/ParagraphTextSegment.java
View File

@ -75,7 +75,7 @@ class ParagraphTextSegment implements PocketWordConstants {
/**
* <p>Sets the style for this segment.</p>
*
* @param data The style describing this segment.
* @param style The style describing this segment.
*/
public void setStyle (TextStyle style) {
pStyle = style;

2
xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentDeserializerImpl.java
View File

@ -284,7 +284,7 @@ implements DOCConstants, OfficeConstants, DocumentDeserializer {
* <code>SXWDocument</code>.
*
* @param docName <code>Document</code> name
* @param str Text content of WordSmith format
* @param data Text content of WordSmith format
*
* @return Resulting <code>SXWDocument</code> object.
*

6
xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentSerializerImpl.java
View File

@ -100,10 +100,6 @@ implements OfficeConstants, DocumentSerializer {
* but this is the only way to not modify most of the existing
* code right now.</p>
*
* @param doc Input should be an XML <code>Document</code>
* object
* @param os Output of <code>PalmDB</code> object
*
* @throws ConvertException If any conversion error occurs.
* @throws IOException If any I/O error occurs.
*/
@ -457,7 +453,7 @@ implements OfficeConstants, DocumentSerializer {
* <i>text:h</i>, <i>text:unordered-list</i> and
* <i>text:ordered-list</i>.
*
* @param Node <code>Node</code> to traverse.
* @param node <code>Node</code> to traverse.
*
* @throws IOException If any I/O error occurs.
*/

2
xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/PluginFactoryImpl.java
View File

@ -126,8 +126,6 @@ public final class PluginFactoryImpl extends SxwPluginFactory
* which is an implementation of the <code>DocumentMerger</code>
* interface.
*
* @param doc <code>Document</code> to merge.
*
* @return A Device Document object
*/
public Document createDeviceDocument(String name, InputStream is)

6
xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/WSDecoder.java
View File

@ -56,7 +56,7 @@ final class WSDecoder implements DOCConstants {
/**
* Decode the text records into a single <code>byte</code> array.
*
* @param Record <code>Record</code> array holding WordSmith
* @param recs <code>Record</code> array holding WordSmith
* contents.
*
* @throws IOException If any I/O error occurs.
@ -113,7 +113,7 @@ final class WSDecoder implements DOCConstants {
/**
* Decode the text records into a <code>Wse</code> array.
*
* @param Record[] <code>Record</code> array holding DOC
* @param recs <code>Record</code> array holding DOC
* contents.
*
* @throws IOException If any I/O error occurs.
@ -173,7 +173,7 @@ final class WSDecoder implements DOCConstants {
* it as a problem with the encoding of that PDB and
* throw <code>IOException</code>.</p>
*
* @param bytes Compressed <code>byte</code> array
* @param cBytes Compressed <code>byte</code> array
* @param textRecordSize Size of uncompressed <code>byte</code>
* array
*

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
View File

@ -228,7 +228,7 @@ public class DOMDocument
* <p>TODO: remove dependency on com.sun.xml.tree.XmlDocument
* package!</p>
*
* @param Document DOM <code>Document</code> object.
* @param doc DOM <code>Document</code> object.
*
* @return <code>byte</code> array of DOM <code>Document</code>
* object.

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java
View File

@ -101,7 +101,7 @@ final class PdbHeader {
* Read in the data for the PDB header. Need to
* preserve the unsigned value for some of the fields.
*
* @param di A <code>DataInput</code> object.
* @param in A <code>DataInput</code> object.
*
* @throws IOException If any I/O error occurs.
*/

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedBinaryObject.java
View File

@ -102,8 +102,6 @@ public class EmbeddedBinaryObject extends EmbeddedObject {
/**
* Package private method that constructs the manifest.xml entries for this
* embedded object.
*
* @return Document <code>Document</code> containing the manifest entries.
*/
void writeManifestData(Document manifestDoc) throws DOMException {
Element objNode = manifestDoc.createElement(OfficeConstants.TAG_MANIFEST_FILE);

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedObject.java
View File

@ -100,8 +100,6 @@ public abstract class EmbeddedObject {
/**
* Package private method that constructs the manifest.xml entries for this
* embedded object.
*
* @return Document <code>Document</code> containing the manifest entries.
*/
abstract void writeManifestData(Document manifestDoc) throws DOMException;
}

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java
View File

@ -832,7 +832,7 @@ public abstract class OfficeDocument
* <p>TODO: remove dependency on com.sun.xml.tree.XmlDocument
* package!</p>
*
* @param Document DOM <code>Document</code> object.
* @param doc DOM <code>Document</code> object.
*
* @return <code>byte</code> array of DOM <code>Document</code>
* object.

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeZip.java
View File

@ -34,7 +34,7 @@ import org.openoffice.xmerge.util.Debug;
/**
* Class used by {@link
* org.openoffice.xmerge.converter.OfficeDocument
* org.openoffice.xmerge.converter.xml.OfficeDocument
* OfficeDocument} to handle reading and writing
* from a ZIP file, as well as storing ZIP entries.
*

4
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/Style.java
View File

@ -28,8 +28,8 @@ import org.w3c.dom.NamedNodeMap;
* <code>ParaStyle</code> are used.
*
* @author David Proulx
* @see <a href="TextStyle.html">TextStyle</a>,
* <a href="ParaStyle.html">ParaStyle</a>
* @see <a href="TextStyle.html">TextStyle</a>
* @see <a href="ParaStyle.html">ParaStyle</a>
*/
public class Style {

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java
View File

@ -441,7 +441,7 @@ public class TextStyle extends Style implements Cloneable {
* Private function to return the value as an element in
* a Comma Separated Value (CSV) format.
*
* @param The value to format.
* @param value The value to format.
*
* @return The formatted value.
*/

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/BookSettings.java
View File

@ -114,7 +114,7 @@ public class BookSettings implements OfficeConstants {
* Adds an XML entry for a particular setting
*
* @param root the root node at which to add the xml entry
* @param attriute the name of the attribute to add
* @param attribute the name of the attribute to add
* @param type the attribute type (int, short etc)
* @param value the value of the attribute
*/

2
xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/SheetSettings.java
View File

@ -227,7 +227,7 @@ public class SheetSettings implements OfficeConstants {
* Adds an XML entry for a particular setting
*
* @param root the root node at which to add the xml entry
* @param attriute the name of the attribute to add
* @param attribute the name of the attribute to add
* @param type the attribute type (int, short etc)
* @param value the value of the attribute
*/