diff options
author | Noel Grandin <noel@peralex.com> | 2012-07-02 13:08:33 +0200 |
---|---|---|
committer | Caolán McNamara <caolanm@redhat.com> | 2012-08-20 12:55:03 +0100 |
commit | 360f566cf91b2b78a39512ce0f87f5375f7e0479 (patch) | |
tree | 19d5a94a0f2eea587bd37aa8f5bcf59286ac6669 /qadevOOo/runner | |
parent | f6a62d9e4106f36aff899c847d63e3198532796e (diff) |
Java update - fix a bunch of javadoc warnings in @param tags
Change-Id: Ibaccfd0312ab6697d8c9887367ea664163767587
Diffstat (limited to 'qadevOOo/runner')
-rw-r--r-- | qadevOOo/runner/convwatch/GraphicalDifferenceCheck.java | 8 | ||||
-rw-r--r-- | qadevOOo/runner/convwatch/ReportDesignerTest.java | 2 | ||||
-rw-r--r-- | qadevOOo/runner/helper/ConfigurationRead.java | 2 | ||||
-rw-r--r-- | qadevOOo/runner/helper/PropertyHelper.java | 2 | ||||
-rw-r--r-- | qadevOOo/runner/helper/URLHelper.java | 2 | ||||
-rw-r--r-- | qadevOOo/runner/lib/MultiPropertyTest.java | 10 | ||||
-rw-r--r-- | qadevOOo/runner/lib/Status.java | 8 | ||||
-rw-r--r-- | qadevOOo/runner/stats/OutProducerFactory.java | 4 | ||||
-rw-r--r-- | qadevOOo/runner/util/DBTools.java | 4 | ||||
-rw-r--r-- | qadevOOo/runner/util/PropertyName.java | 2 | ||||
-rw-r--r-- | qadevOOo/runner/util/utils.java | 12 |
11 files changed, 28 insertions, 28 deletions
diff --git a/qadevOOo/runner/convwatch/GraphicalDifferenceCheck.java b/qadevOOo/runner/convwatch/GraphicalDifferenceCheck.java index 7bf52fd11dad..c4e1a5940b2d 100644 --- a/qadevOOo/runner/convwatch/GraphicalDifferenceCheck.java +++ b/qadevOOo/runner/convwatch/GraphicalDifferenceCheck.java @@ -125,7 +125,7 @@ public class GraphicalDifferenceCheck * needed very much disk space (up to 10MB per page). * The path _sOutputPath must be writeable. * @param _sReferencePath the directory where the document will print as file or export as pdf. - * @param _GTA Helper class for lot of parameter to control the office. + * @param _aGTA Helper class for lot of parameter to control the office. * * Disadvantage: stops rest if one test file has a problem. */ @@ -144,7 +144,7 @@ public class GraphicalDifferenceCheck * needed very much disk space (up to 10MB per page). * The path _sOutputPath must be writeable. * @param _sDiffPath Path to older differences. - * @param _GTA Helper class for lot of parameter to control the office. + * @param _aGTA Helper class for lot of parameter to control the office. * * * Stops all, if one creation of reference fails @@ -247,10 +247,10 @@ public class GraphicalDifferenceCheck * These documents need sufficient disk space (up to 10MB per page). * A directory structure will be created, which is a mirrored from input path. * - * @param resultDocName Name by which the xComponent shall be saved as OpenOffice.org XML document. + * @param _resultDocName Name by which the xComponent shall be saved as OpenOffice.org XML document. * If provided without suffix, the suffix will be derived from the export filter. * @param _sReferencePath the directory where the document will print as file or export as pdf. - * @param _GTA Helper class for lot of parameter to control the office. + * @param _aGTA Helper class for lot of parameter to control the office. */ public static boolean checkOneFile(XComponent xComponent, String _sOutputPath, String _resultDocName, String _sReferencePath, GraphicalTestArguments _aGTA ) throws ConvWatchException { diff --git a/qadevOOo/runner/convwatch/ReportDesignerTest.java b/qadevOOo/runner/convwatch/ReportDesignerTest.java index a70bbc58176f..ea1a2d8840fe 100644 --- a/qadevOOo/runner/convwatch/ReportDesignerTest.java +++ b/qadevOOo/runner/convwatch/ReportDesignerTest.java @@ -112,7 +112,7 @@ class PropertyHelper { /** Create a PropertyValue[] from a ArrayList - @param _aArrayList + @param _aPropertyList @return a PropertyValue[] */ public static PropertyValue[] createPropertyValueArrayFormArrayList(ArrayList<PropertyValue> _aPropertyList) diff --git a/qadevOOo/runner/helper/ConfigurationRead.java b/qadevOOo/runner/helper/ConfigurationRead.java index 557e1199ff45..a3af03c81ee3 100644 --- a/qadevOOo/runner/helper/ConfigurationRead.java +++ b/qadevOOo/runner/helper/ConfigurationRead.java @@ -120,7 +120,7 @@ public class ConfigurationRead { /** * Get contents of a node by its hierarchical name. - * @param The hierarchical name of the node. + * @param name The hierarchical name of the node. * @return The contents as an object */ public Object getByHierarchicalName(String name) throws NoSuchElementException { diff --git a/qadevOOo/runner/helper/PropertyHelper.java b/qadevOOo/runner/helper/PropertyHelper.java index c91b4053aeb4..05d6a7d1c870 100644 --- a/qadevOOo/runner/helper/PropertyHelper.java +++ b/qadevOOo/runner/helper/PropertyHelper.java @@ -26,7 +26,7 @@ public class PropertyHelper { /** Create a PropertyValue[] from a ArrayList - @param _aArrayList + @param _aPropertyList @return a PropertyValue[] */ public static PropertyValue[] createPropertyValueArrayFormArrayList(ArrayList<PropertyValue> _aPropertyList) diff --git a/qadevOOo/runner/helper/URLHelper.java b/qadevOOo/runner/helper/URLHelper.java index bd091a988f01..57b8d639bf5d 100644 --- a/qadevOOo/runner/helper/URLHelper.java +++ b/qadevOOo/runner/helper/URLHelper.java @@ -233,7 +233,7 @@ public class URLHelper * used for further purposes. One parameter define the start directory, * another one describe the url protocol, which the return URL names should have. * - * @param sDir + * @param sStartDir * the start directory, which should include all test files * * @return [Vector] diff --git a/qadevOOo/runner/lib/MultiPropertyTest.java b/qadevOOo/runner/lib/MultiPropertyTest.java index 5935fb697c81..9e69f2f1b049 100644 --- a/qadevOOo/runner/lib/MultiPropertyTest.java +++ b/qadevOOo/runner/lib/MultiPropertyTest.java @@ -253,11 +253,11 @@ public class MultiPropertyTest extends MultiMethodTest /** * The method checks result of setting a new value to the * property based o the following arguments: - * @propName - the property to test - * @oldValue - the old value of the property, before changing it. - * @newValue - the new value the property has been set with - * @resValue - the value of the property after having changed it - * @exception - if not null - the exception thrown by + * @param propName - the property to test + * @param oldValue - the old value of the property, before changing it. + * @param newValue - the new value the property has been set with + * @param resValue - the value of the property after having changed it + * @param exception - if not null - the exception thrown by * XPropertySet.setPropertyValue, else indicates * normal method completion. * diff --git a/qadevOOo/runner/lib/Status.java b/qadevOOo/runner/lib/Status.java index 5c47f5bac5e6..c6629f520698 100644 --- a/qadevOOo/runner/lib/Status.java +++ b/qadevOOo/runner/lib/Status.java @@ -38,8 +38,8 @@ public class Status extends SimpleStatus { /** * Construct a status: use runState and state - * @param runState: either PASSED, SKIPPED, etc. - * @param state: OK or FAILED. + * @param runState either PASSED, SKIPPED, etc. + * @param state OK or FAILED. */ public Status(int runState, boolean state ) { super(runState, state); @@ -47,8 +47,8 @@ public class Status extends SimpleStatus { /** * Construct a status: use own message and state. - * @parame messaeg An own message for the status. - * @param state: OK or FAILED. + * @param message An own message for the status. + * @param state OK or FAILED. */ public Status(String message, boolean state) { super( message, state ); diff --git a/qadevOOo/runner/stats/OutProducerFactory.java b/qadevOOo/runner/stats/OutProducerFactory.java index b5c95da36b66..c900cf484e40 100644 --- a/qadevOOo/runner/stats/OutProducerFactory.java +++ b/qadevOOo/runner/stats/OutProducerFactory.java @@ -33,7 +33,7 @@ public class OutProducerFactory { * <li>DataBaseOut - If set to true, a database outproducer is created. * <li>OutProducer - The value of this parameter names the class that is created. * </ul> - * @param Parameters of the test. + * @param param Parameters of the test. * @return The created out producer. */ public static LogWriter createOutProducer(HashMap<String,Object> param) { @@ -62,7 +62,7 @@ public class OutProducerFactory { /** * Create a database out producer. - * @param The test parameters + * @param param The test parameters * @return The database out producer, or null if it couldn't be created. */ public static LogWriter createDataBaseOutProducer(HashMap<String,Object> param) { diff --git a/qadevOOo/runner/util/DBTools.java b/qadevOOo/runner/util/DBTools.java index f54d2e5f2d8d..37894e6d3fe0 100644 --- a/qadevOOo/runner/util/DBTools.java +++ b/qadevOOo/runner/util/DBTools.java @@ -745,7 +745,7 @@ public class DBTools { * are declared for column index fast find. * @param statement object used for executing a static SQL * statement and obtaining the results produced by it. - * @param table Test table name. + * @param tbl_name Test table name. */ protected void createMySQLTable(Statement statement, String tbl_name) throws java.sql.SQLException { @@ -793,7 +793,7 @@ public class DBTools { * Drops table. * @param statement object used for executing a static SQL * statement and obtaining the results produced by it. - * @param table Test table name. + * @param tbl_name Test table name. */ protected void dropMySQLTable(Statement statement, String tbl_name) throws java.sql.SQLException { diff --git a/qadevOOo/runner/util/PropertyName.java b/qadevOOo/runner/util/PropertyName.java index 0a328eea59a3..b7a8598616a7 100644 --- a/qadevOOo/runner/util/PropertyName.java +++ b/qadevOOo/runner/util/PropertyName.java @@ -128,7 +128,7 @@ public interface PropertyName { final public static String CYGWIN = "Cygwin"; /** * parameter name: "NoCwsAttach"<p> - * If this paraeter is set to "true" , a status of CWS-UnoAPI-Tests was not attached to EIS<p> + * If this parameter is set to "true" , a status of CWS-UnoAPI-Tests was not attached to EIS<p> * @see tests.complex.unoapi.CheckModuleAPI */ final public static String NO_CWS_ATTACH = "NoCwsAttach"; diff --git a/qadevOOo/runner/util/utils.java b/qadevOOo/runner/util/utils.java index 08acdc3800ff..78019ae01947 100644 --- a/qadevOOo/runner/util/utils.java +++ b/qadevOOo/runner/util/utils.java @@ -433,7 +433,7 @@ public class utils { /** * converts a fileURL to a system URL - * @param a file URL + * @param fileURL a file URL * @return a system URL */ public static String getSystemURL(String fileURL) { @@ -484,7 +484,7 @@ public class utils { /** * This method deletes via office the given file URL. It checks the existance * of <CODE>fileURL</CODE>. If exists it will be deletet. - * @param msf the multiservice factory + * @param xMsf the multiservice factory * @param fileURL the file to delete * @return true if the file could be deletet or the file does not exist */ @@ -509,9 +509,9 @@ public class utils { /** * This method copies via office a given file to a new one - * @param msf the multi service factory - * @param oldF the source file - * @param newF the destination file + * @param xMsf the multi service factory + * @param source the source file + * @param destinaion the destination file * @return true at success */ public static boolean copyFile(XMultiServiceFactory xMsf, String source, String destinaion) { @@ -956,7 +956,7 @@ public class utils { /** * dispatches given <CODE>URL</CODE> to the <CODE>XController</CODE> * @param xMSF the <CODE>XMultiServiceFactory</CODE> - * @param xComp the <CODE>XController</CODE> to query for a XDispatchProvider + * @param xCont the <CODE>XController</CODE> to query for a XDispatchProvider * @param URL the <CODE>URL</CODE> to dispatch * @throws java.lang.Exception throws <CODE>java.lang.Exception</CODE> on any error */ |