java: remove useless javadoc tags

that are not conveying any useful information

Change-Id: Ic37934b8cc376fcdcb3d295232452f411dfd43b1

12 files changed, 26 insertions, 122 deletions

diff --git a/odk/examples/DevelopersGuide/GUI/UnoDialogSample.java b/odk/examples/DevelopersGuide/GUI/UnoDialogSample.java
index 71d2314ccda1..1650c9af583c 100644
--- a/odk/examples/DevelopersGuide/GUI/UnoDialogSample.java
+++ b/odk/examples/DevelopersGuide/GUI/UnoDialogSample.java
@@ -188,10 +188,6 @@ public class UnoDialogSample implements XTextListener, XSpinListener, XActionLis
     }
 
 
-    /**
-     * @param _sKeyName
-     * @return
-     */
     public XNameAccess getRegistryKeyContent(String _sKeyName){
         try {
             PropertyValue[] aNodePath = new PropertyValue[1];
@@ -313,9 +309,6 @@ public class UnoDialogSample implements XTextListener, XSpinListener, XActionLis
      * create a peer for this
      * dialog, using the given
      * peer as a parent.
-     * @param parentPeer
-     * @return
-     * @throws java.lang.Exception
      */
     public XWindowPeer createWindowPeer(XWindowPeer _xWindowParentPeer) {
         try{
@@ -354,8 +347,6 @@ public class UnoDialogSample implements XTextListener, XSpinListener, XActionLis
      * Creates a peer for this
      * dialog, using the active OO frame
      * as the parent window.
-     * @return
-     * @throws java.lang.Exception
      */
     public XWindowPeer createWindowPeer() {
         return createWindowPeer(null);
diff --git a/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java b/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java
index 608ad199c065..00821f648016 100644
--- a/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java
+++ b/odk/examples/DevelopersGuide/OfficeDev/ContextMenuInterceptor.java
@@ -44,7 +44,6 @@ public class ContextMenuInterceptor implements XContextMenuInterceptor {
      *Description of the Method
      *
      *@param  args  Description of Parameter
-     *@since
      */
     public static void main(String args[])
     {
@@ -143,7 +142,6 @@ public class ContextMenuInterceptor implements XContextMenuInterceptor {
      *Description of the Method
      *
      *@param  args  Description of Parameter
-     *@since
      */
     public ContextMenuInterceptorAction notifyContextMenuExecute(
              com.sun.star.ui.ContextMenuExecuteEvent aEvent ) throws RuntimeException {
diff --git a/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java b/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java
index af37982133f7..0b14189bbf2c 100644
--- a/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java
+++ b/odk/examples/DevelopersGuide/UCB/ChildrenRetriever.java
@@ -61,13 +61,12 @@ public class ChildrenRetriever {
     /**
      * Constructor. Create a new connection with the specific args to a running office
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...       (optional)
      *                          -propNames=... (optional)
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public ChildrenRetriever( String args[] ) throws java.lang.Exception {
 
@@ -88,8 +87,6 @@ public class ChildrenRetriever {
      *
      *@return     Returns children properties values if values successfully retrieved,
      *                     null otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public ArrayList<ArrayList<Object>> getChildren()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -100,11 +97,8 @@ public class ChildrenRetriever {
     /**
      * Open a folder content, get properties values for the properties.
      *
-     *@param  properties
      *@return Returns children properties values if values successfully retrieved,
      *                 null otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public ArrayList<ArrayList<Object>> getChildren( ArrayList<String> properties )
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -193,8 +187,7 @@ public class ChildrenRetriever {
     /**
      * Parse arguments
      *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
+     *@param      args   Arguments
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
diff --git a/odk/examples/DevelopersGuide/UCB/DataStreamComposer.java b/odk/examples/DevelopersGuide/UCB/DataStreamComposer.java
index 2d67cde0e4ae..81977ae2c005 100644
--- a/odk/examples/DevelopersGuide/UCB/DataStreamComposer.java
+++ b/odk/examples/DevelopersGuide/UCB/DataStreamComposer.java
@@ -53,14 +53,13 @@ public class DataStreamComposer {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...               (optional)
      *                          -srcURL=...            (optional)
      *                          -workdir=...           (optional)
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public DataStreamComposer( String args[] ) throws java.lang.Exception {
 
@@ -80,9 +79,6 @@ public class DataStreamComposer {
      * See Constructor.
      *
      *@return boolean   Result
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
-     *@exception  java.lang.Exception
      */
     public boolean setDataStream()
         throws com.sun.star.ucb.CommandAbortedException,
@@ -98,9 +94,6 @@ public class DataStreamComposer {
      *
      *@param  String    Source URL
      *@return boolean   Returns true if data stream successfully seted, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
-     *@exception  java.lang.Exception
      */
     public boolean setDataStream( String sourceURL )
         throws com.sun.star.ucb.CommandAbortedException,
@@ -122,10 +115,7 @@ public class DataStreamComposer {
     /**
      * Write the document data stream of a document content...
      *
-     *@param  XInputStream   Stream
      *@return boolean        Returns true if data stream successfully seted, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public boolean setDataStream( XInputStream stream )
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -166,9 +156,6 @@ public class DataStreamComposer {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
diff --git a/odk/examples/DevelopersGuide/UCB/DataStreamRetriever.java b/odk/examples/DevelopersGuide/UCB/DataStreamRetriever.java
index e83a307e3e83..62ca893cfcdf 100644
--- a/odk/examples/DevelopersGuide/UCB/DataStreamRetriever.java
+++ b/odk/examples/DevelopersGuide/UCB/DataStreamRetriever.java
@@ -53,12 +53,11 @@ public class DataStreamRetriever {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=... (optional)
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public DataStreamRetriever( String args[] ) throws java.lang.Exception {
 
@@ -78,8 +77,6 @@ public class DataStreamRetriever {
      *
      *@return     XInputStream  Returns input stream if stream successfully retrieved,
      *                          null otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public XInputStream getDataStream()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -118,8 +115,7 @@ public class DataStreamRetriever {
     /**
      * Parse arguments
      *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
+     *@param      args   Arguments
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
@@ -152,9 +148,6 @@ public class DataStreamRetriever {
 
     /**
      *  Print Stream content.
-     *
-     *@param    XInputStream
-     *@exception  com.sun.star.uno.Exception
      */
     public void printStream( XInputStream data )
         throws com.sun.star.uno.Exception {
diff --git a/odk/examples/DevelopersGuide/UCB/Helper.java b/odk/examples/DevelopersGuide/UCB/Helper.java
index 0a53a2d4d574..fe427a902930 100644
--- a/odk/examples/DevelopersGuide/UCB/Helper.java
+++ b/odk/examples/DevelopersGuide/UCB/Helper.java
@@ -64,8 +64,6 @@ public class Helper {
      *  Constructor, create a new instance of the ucb. UNO is bootstrapped and
      *  the remote office service manger is used to create the ucb. If necessary
      *  a new office process is started.
-     *
-     *  @exception  java.lang.Exception
      */
     public Helper(String url) throws java.lang.Exception {
         m_contenturl    = url;
@@ -84,7 +82,6 @@ public class Helper {
      * Returns created identifier object for given URL..
      *
      *@return     XContent       Created identifier object for given URL
-     *@exception  java.lang.Exception
      */
     public XContent createUCBContent() throws java.lang.Exception {
         return createUCBContent( getContentURL() );
@@ -93,9 +90,8 @@ public class Helper {
     /**
      * Returned created identifier object for given URL.
      *
-     *@param      String         Connect URL. Example : -url=file:///
-     *@return     XContent       Created identifier object for given URL
-     *@exception  java.lang.Exception
+     *@param      connectURL         Connect URL. Example : -url=file:///
+     *@return  Created identifier object for given URL
      */
     public XContent createUCBContent( String connectURL ) throws java.lang.Exception {
         XContent content = null;
diff --git a/odk/examples/DevelopersGuide/UCB/MyActiveDataSink.java b/odk/examples/DevelopersGuide/UCB/MyActiveDataSink.java
index 4d111dc740a8..9ef646e47beb 100644
--- a/odk/examples/DevelopersGuide/UCB/MyActiveDataSink.java
+++ b/odk/examples/DevelopersGuide/UCB/MyActiveDataSink.java
@@ -55,8 +55,6 @@ public class MyActiveDataSink implements XActiveDataSink {
 
     /**
      *   Plugs the input stream.
-     *
-     *@param  XInputStream
      */
     public void setInputStream( XInputStream aStream ) {
         m_aStream = aStream;
diff --git a/odk/examples/DevelopersGuide/UCB/PropertiesComposer.java b/odk/examples/DevelopersGuide/UCB/PropertiesComposer.java
index 19a11139bad8..013cdc2d783a 100644
--- a/odk/examples/DevelopersGuide/UCB/PropertiesComposer.java
+++ b/odk/examples/DevelopersGuide/UCB/PropertiesComposer.java
@@ -55,7 +55,7 @@ public class PropertiesComposer {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...        (optional)
      *                          -propNames=...  (optional)
      *                          -propValues=... (optional)
@@ -63,7 +63,6 @@ public class PropertiesComposer {
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public PropertiesComposer( String args[] ) throws java.lang.Exception {
 
@@ -84,8 +83,6 @@ public class PropertiesComposer {
      *
      *@return Object[]  Returns null or instance object of com.sun.star.uno.Any
      *                  if values successfully seted, properties otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public Object[] setProperties()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -97,12 +94,8 @@ public class PropertiesComposer {
     /**
      *  Set values of the properties.
      *
-     *@param  properties
-     *@param  propertiesValue
      *@return Object[]  Returns null or instance object of com.sun.star.uno.Any
      *                  if values successfully seted, properties otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public Object[] setProperties( ArrayList<String> properties, ArrayList<String> propertiesValues )
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -185,9 +178,6 @@ public class PropertiesComposer {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
diff --git a/odk/examples/DevelopersGuide/UCB/PropertiesRetriever.java b/odk/examples/DevelopersGuide/UCB/PropertiesRetriever.java
index 002d5c4e6cc2..0b984907ab77 100644
--- a/odk/examples/DevelopersGuide/UCB/PropertiesRetriever.java
+++ b/odk/examples/DevelopersGuide/UCB/PropertiesRetriever.java
@@ -57,13 +57,12 @@ public class PropertiesRetriever {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...       (optional)
      *                          -propNames=... (optional)
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public PropertiesRetriever( String args[] ) throws java.lang.Exception {
 
@@ -82,10 +81,7 @@ public class PropertiesRetriever {
      * This method requires the main and the optional arguments to be set in order to work.
      * See Constructor.
      *
-     *@param  Vector   Properties
-     *@return Vector   Returns Properties values if values successfully retrieved, null otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@return Properties values if values successfully retrieved, null otherwise
      */
     public ArrayList<Object> getPropertyValues()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -96,10 +92,7 @@ public class PropertiesRetriever {
     /**
      *  Get values of the properties.
      *
-     *@param  Vector   Properties
-     *@return Vector   Returns Properties values if values successfully retrieved, null otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@return Properties values if values successfully retrieved, null otherwise
      */
     public ArrayList<Object> getPropertyValues( ArrayList<String> properties )
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -161,9 +154,6 @@ public class PropertiesRetriever {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
@@ -209,8 +199,6 @@ public class PropertiesRetriever {
     /**
      *  Create a new connection with the specific args to a running office and
      *  get the properties values from a resource.
-     *
-     *@param  String[]   Arguments
      */
     public static void main ( String args[] ) {
         System.out.println( "\n" );
diff --git a/odk/examples/DevelopersGuide/UCB/ResourceCreator.java b/odk/examples/DevelopersGuide/UCB/ResourceCreator.java
index 566266246e77..4279f94a1300 100644
--- a/odk/examples/DevelopersGuide/UCB/ResourceCreator.java
+++ b/odk/examples/DevelopersGuide/UCB/ResourceCreator.java
@@ -57,7 +57,7 @@ public class ResourceCreator {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...     (optional)
      *                          -name=...    (optional)
      *                          -srcURL=...  (optional)
@@ -65,7 +65,6 @@ public class ResourceCreator {
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public ResourceCreator( String args[] ) throws java.lang.Exception {
 
@@ -93,8 +92,6 @@ public class ResourceCreator {
      *  See Constructor.
      *
      *@return boolean  Returns true if resource successfully created, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
      */
     public boolean createNewResource()
         throws com.sun.star.ucb.CommandAbortedException,
@@ -109,11 +106,9 @@ public class ResourceCreator {
     /**
      *  Create a new resource.
      *
-     *@param  String   Source resource URL
-     *@param  String   New resource name
-     *@return boolean  Returns true if resource successfully created, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@param  sourceURL   Source resource URL
+     *@param  name   New resource name
+     *@return true if resource successfully created, false otherwise
      */
     public boolean createNewResource( String sourceURL, String name )
         throws com.sun.star.ucb.CommandAbortedException,
@@ -135,11 +130,9 @@ public class ResourceCreator {
     /**
      *  Create a new resource.
      *
-     *@param  XInputStream   Source resource stream
-     *@param  String         New resource name
-     *@return boolean        Returns true if resource successfully created, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@param  stream   Source resource stream
+     *@param  name         New resource name
+     *@return true if resource successfully created, false otherwise
      */
     public boolean createNewResource( XInputStream stream, String name )
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -224,9 +217,6 @@ public class ResourceCreator {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
@@ -276,8 +266,6 @@ public class ResourceCreator {
     /**
      *  Create a new connection with the specific args to a running office and
      *  create a new resource.
-     *
-     *@param  String[]   Arguments
      */
     public static void main ( String args[] ) {
         System.out.println( "\n" );
diff --git a/odk/examples/DevelopersGuide/UCB/ResourceManager.java b/odk/examples/DevelopersGuide/UCB/ResourceManager.java
index a23921fc1993..26f19c0e7150 100644
--- a/odk/examples/DevelopersGuide/UCB/ResourceManager.java
+++ b/odk/examples/DevelopersGuide/UCB/ResourceManager.java
@@ -55,7 +55,7 @@ public class ResourceManager {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...             (optional)
      *                          -targetFolderURL=... (optional)
      *                          -newTitle=...        (optional)
@@ -64,7 +64,6 @@ public class ResourceManager {
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public ResourceManager( String args[] ) throws java.lang.Exception {
 
@@ -83,9 +82,7 @@ public class ResourceManager {
      *  This method requires the main and the optional arguments to be set in order to work.
      *  See Constructor.
      *
-     *@return boolean  Returns true if resource successfully transferred, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@return true if resource successfully transferred, false otherwise
      */
     public boolean transferResource()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -99,12 +96,10 @@ public class ResourceManager {
     /**
      *  Copy, move or create a link for a resource.
      *
-     *@param  String   Source URL
-     *@param  String   Target folder URL
-     *@param  String   Transferring operation (copy, move, link)
-     *@return boolean  Returns true if resource successfully transferred, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@param  sourceURL   Source URL
+     *@param  targetFolderURL   Target folder URL
+     *@param  transOperation   Transferring operation (copy, move, link)
+     *@return true if resource successfully transferred, false otherwise
      */
     public boolean transferResource(
             String sourceURL, String targetFolderURL,
@@ -185,9 +180,6 @@ public class ResourceManager {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
@@ -243,8 +235,6 @@ public class ResourceManager {
     /**
      *  Create a new connection with the specific args to a running office and
      *  copy, move or create links a resource.
-     *
-     *@param  String[]   Arguments
      */
     public static void main ( String args[] ) {
 
diff --git a/odk/examples/DevelopersGuide/UCB/ResourceRemover.java b/odk/examples/DevelopersGuide/UCB/ResourceRemover.java
index 560132acbf0e..0efa68a00d8e 100644
--- a/odk/examples/DevelopersGuide/UCB/ResourceRemover.java
+++ b/odk/examples/DevelopersGuide/UCB/ResourceRemover.java
@@ -47,13 +47,12 @@ public class ResourceRemover {
     /**
      * Constructor.
      *
-     *@param      String[]   This construtor requires the arguments:
+     *@param      args   This construtor requires the arguments:
      *                          -url=...     (optional)
      *                          -workdir=... (optional)
      *                       See Help (method printCmdLineUsage()).
      *                       Without the arguments a new connection to a
      *                       running office cannot created.
-     *@exception  java.lang.Exception
      */
     public ResourceRemover( String args[] ) throws java.lang.Exception {
 
@@ -70,9 +69,7 @@ public class ResourceRemover {
     /**
      *  Delete resource.
      *
-     *@return     boolean   Returns true if resource successfully deleted, false otherwise
-     *@exception  com.sun.star.ucb.CommandAbortedException
-     *@exception  com.sun.star.uno.Exception
+     *@return true if resource successfully deleted, false otherwise
      */
     public boolean deleteResource()
         throws com.sun.star.ucb.CommandAbortedException, com.sun.star.uno.Exception {
@@ -104,9 +101,6 @@ public class ResourceRemover {
 
     /**
      * Parse arguments
-     *
-     *@param      String[]   Arguments
-     *@exception  java.lang.Exception
      */
     public void parseArguments( String[] args ) throws java.lang.Exception {
 
@@ -144,8 +138,6 @@ public class ResourceRemover {
     /**
      *  Create a new connection with the specific args to a running office and
      *  delete a resource.
-     *
-     *@param  String[]   Arguments
      */
     public static void main ( String args[] ) {