diff gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java @ 815:22c18083225e

Removed compiler warnings while JavaDoc generation. gnv-artifacts/trunk@900 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Mon, 12 Apr 2010 06:59:33 +0000
parents feae2f9d6c6f
children 41234fcf4c7e
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java	Fri Apr 09 14:34:45 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/SelectProductArtifact.java	Mon Apr 12 06:59:33 2010 +0000
@@ -75,9 +75,6 @@
     public static final String XPATH_SETUP_PARAMETER_NODES =
         "/art:action/art:factory/art:parameter";
 
-    /**
-     *
-     */
     public static final String XFORM_URL    = "http://www.w3.org/2002/xforms";
 
     /**
@@ -151,7 +148,7 @@
 
     /**
      *
-     * @param products
+     * @param products Insert a bunch of products.
      */
     public void setProducts(Map products) {
         this.products = products;
@@ -220,9 +217,9 @@
      * was sucessfully called before, this artifact is replaced with a concrete
      * product artifact.
      *
-     * @param target
-     * @param context
-     * @return
+     * @param target The advance document.
+     * @param context The CallContext.
+     * @return a document with an error or success message.
      */
     @Override
     public Document advance(Document target, CallContext context) {
@@ -290,9 +287,9 @@
      * Create a describe document including the user interface description. The
      * user gets the choice to select a product supported by the current fis.
      *
-     * @param data
-     * @param context
-     * @return
+     * @param data The describe document.
+     * @param context The CallContext.
+     * @return A document with an error or success message.
      */
     @Override
     public Document describe(Document data, CallContext context) {
@@ -380,9 +377,9 @@
     /**
      * Append products to the describe document.
      *
-     * @param document
-     * @param parent
-     * @param context
+     * @param document The describe document.
+     * @param parent The node the products should be appended to.
+     * @param context The CallContext object.
      */
     protected void appendProducts(
         Document document,
@@ -413,9 +410,9 @@
      * Append the product select box to the user interface description of the
      * describe document.
      *
-     * @param document
-     * @param node
-     * @param callMeta
+     * @param document The describe document.
+     * @param node The node the products should be appended to.
+     * @param callMeta The CallMeta object.
      */
     protected void appendSelectProducts(
         Document document,
@@ -470,9 +467,9 @@
     /**
      * Create a feed document.
      *
-     * @param uuid
-     * @param hash
-     * @return
+     * @param uuid The UUID of the current artifact.
+     * @param hash The hash of the current artifact.
+     * @return the feed document.
      */
     protected Document feedDocument(String uuid, String hash) {
         Document document = XMLUtils.newDocument();

http://dive4elements.wald.intevation.org