[Andspidclient-commit] SF.net SVN: andspidclient:[172] trunk/src/main/java/au/csiro/doiclient/ AndsDoiClient.java

[<jav...@us...>]

Revision: 172
          http://andspidclient.svn.sourceforge.net/andspidclient/?rev=172&view=rev
Author:   javinovich
Date:     2012-08-03 03:11:20 +0000 (Fri, 03 Aug 2012)
Log Message:
-----------
DMSTECH-3819: 
- Update javadoc as per DAPCRU-152 Review

Modified Paths:
--------------
    trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java

Modified: trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java
===================================================================
--- trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java	2012-08-02 02:17:06 UTC (rev 171)
+++ trunk/src/main/java/au/csiro/doiclient/AndsDoiClient.java	2012-08-03 03:11:20 UTC (rev 172)
@@ -290,6 +290,7 @@
      * @param debug
      *            Optional parameter. Activates debug flag for WS call false => debug=false will be passed true =>
      *            debug=true will be passed If ommitted no debug flag will be added to request
+     *            See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -335,6 +336,7 @@
      *          false => debug=false will be passed
      *          true  => debug=true will be passed
      *          If ommitted no debug flag will be added to request
+     *          See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -369,6 +371,7 @@
      *          false => debug=false will be passed
      *          true  => debug=true will be passed
      *          If ommitted no debug flag will be added to request
+     *          See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -406,6 +409,7 @@
      *          false => debug=false will be passed
      *          true  => debug=true will be passed
      *          If ommitted no debug flag will be added to request
+     *          See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -458,6 +462,7 @@
      *          false => debug=false will be passed
      *          true  => debug=true will be passed
      *          If ommitted no debug flag will be added to request
+     *          See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -514,10 +519,13 @@
      * @param doi
      *            that needs to be activated/ deactivated.
      * @param activate
-     *            boolean flag indicating whether to activate or deactivate. * @param debug Optional parameter.
-     *            Activates debug flag for WS call false => debug=false will be passed true => debug=true will be passed
+     *            boolean flag indicating whether to activate or deactivate. 
+     * @param debug Optional parameter.
+     *            Activates debug flag for WS call 
+     *            false => debug=false will be passed 
+     *            true => debug=true will be passed
      *            If ommitted no debug flag will be added to request
-     * 
+     *            See {@link AndsDoiClient} general documentation for details
      * @return AndsDoiResponse {@link AndsDoiResponse} Response object holding the components of the response.
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
@@ -557,7 +565,8 @@
      *          Optional parameter. Activates debug flag for WS call
      *          false => debug=false will be passed
      *          true  => debug=true will be passed
-     *          If ommitted no debug flag will be added to request            
+     *          If ommitted no debug flag will be added to request
+     *          See {@link AndsDoiClient} general documentation for details
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
      * @throws IllegalArgumentException
@@ -584,8 +593,12 @@
      * @param doi
      *            DOI for which the meta-data is requested.
      * @param debug
-     *            Optional parameter. Activates debug flag for WS call false => debug=false will be passed true =>
-     *            debug=true will be passed If ommitted no debug flag will be added to request
+     *            Optional parameter. 
+     *            Activates debug flag for WS call 
+     *            false => debug=false will be passed 
+     *            true => debug=true will be passed 
+     *            If ommitted no debug flag will be added to request
+     *            See {@link AndsDoiClient} general documentation for details
      * @throws IllegalStateException
      *             thrown if the parameters need to call the ANDS DOI service have not been provided.
      * @throws IllegalArgumentException

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.