From 0ba96b399d70eac60ece03f4e438125736169d5b Mon Sep 17 00:00:00 2001
From: Tobias Kellner <tobias.kellner@iaik.tugraz.at>
Date: Tue, 27 Oct 2015 20:12:12 +0100
Subject: JavaDoc fixes

---
 .../main/java/at/gv/egiz/bku/binding/BindingProcessorManager.java | 2 --
 .../java/at/gv/egiz/bku/binding/BindingProcessorManagerImpl.java  | 4 ++--
 .../src/main/java/at/gv/egiz/bku/binding/DataUrlResponse.java     | 2 +-
 .../src/main/java/at/gv/egiz/bku/binding/FormParameterStore.java  | 8 --------
 .../java/at/gv/egiz/bku/binding/HTTPBindingProcessorImpl.java     | 2 +-
 .../main/java/at/gv/egiz/bku/binding/HttpsDataURLConnection.java  | 2 --
 bkucommon/src/main/java/at/gv/egiz/bku/binding/IdFactory.java     | 2 +-
 7 files changed, 5 insertions(+), 17 deletions(-)

(limited to 'bkucommon/src/main/java/at/gv/egiz/bku/binding')

diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManager.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManager.java
index c4f535a9..069c23bb 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManager.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManager.java
@@ -71,13 +71,11 @@ public interface BindingProcessorManager {
 
   /**
    * Schedules the given BindingProcessor for processing.
-   * <p>
    * <ol>
    * <li>Creates a processing context with the given <code>id</code>.</li>
    * <li>Schedules the given BindingProcessor for processing, and</li>
    * <li>Immediately returns the processing context.</li>
    * </ol>
-   * </p>
    * 
    * @param id
    * @param bindingProcessor
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManagerImpl.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManagerImpl.java
index ef911e0b..17146c90 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManagerImpl.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/BindingProcessorManagerImpl.java
@@ -115,14 +115,14 @@ public class BindingProcessorManagerImpl implements BindingProcessorManager, Com
   }
 
   /**
-   * @return the factoryMap
+   * @return the factory List
    */
   public List<BindingProcessorFactory> getFactories() {
     return factories;
   }
 
   /**
-   * @param factoryMap the factoryMap to set
+   * @param factories the factory List to set
    */
   public void setFactories(List<BindingProcessorFactory> factories) {
     this.factories = factories;
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlResponse.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlResponse.java
index 8cd88109..85bb5a3a 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlResponse.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/DataUrlResponse.java
@@ -80,7 +80,7 @@ public class DataUrlResponse extends StreamData {
   }
 
   /**
-   * Checks if the http response equals "<ok/>"
+   * Checks if the http response equals "&lt;ok/&gt;"
    * 
    * @throws IOException
    */
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/FormParameterStore.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/FormParameterStore.java
index a95909f5..57541fb4 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/FormParameterStore.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/FormParameterStore.java
@@ -101,14 +101,6 @@ public class FormParameterStore implements FormParameter {
     }
   }
 
-  /**
-   * Reads all data from the stream and stores it internally. The stream will
-   * not be closed.
-   * 
-   * @param datSource
-   * @param formName
-   * @param contentType
-   */
   @Override
   public String getFormParameterContentType() {
     ensureInitialized();
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/HTTPBindingProcessorImpl.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/HTTPBindingProcessorImpl.java
index e7bc2f33..4f9260d2 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/HTTPBindingProcessorImpl.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/HTTPBindingProcessorImpl.java
@@ -82,7 +82,7 @@ import at.gv.egiz.stal.STALRequest;
  * Class performing the HTTP binding as defined by the CCE specification.
  * Currently a huge monolithic class.
  * 
- * @TODO refactor
+ * TODO: refactor
  */
 @SuppressWarnings("unchecked")
 public class HTTPBindingProcessorImpl extends AbstractBindingProcessor implements
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/HttpsDataURLConnection.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/HttpsDataURLConnection.java
index f1bc293f..6451e6ee 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/HttpsDataURLConnection.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/HttpsDataURLConnection.java
@@ -25,7 +25,6 @@
 
 package at.gv.egiz.bku.binding;
 
-import java.io.IOException;
 import java.net.URL;
 import java.security.cert.Certificate;
 
@@ -39,7 +38,6 @@ public abstract class HttpsDataURLConnection extends HttpDataURLConnection {
    * Construct a new 
    * 
    * @param url
-   * @throws IOException 
    */
   public HttpsDataURLConnection(URL url) {
     super(url);
diff --git a/bkucommon/src/main/java/at/gv/egiz/bku/binding/IdFactory.java b/bkucommon/src/main/java/at/gv/egiz/bku/binding/IdFactory.java
index 8d68f177..16a7bf4b 100644
--- a/bkucommon/src/main/java/at/gv/egiz/bku/binding/IdFactory.java
+++ b/bkucommon/src/main/java/at/gv/egiz/bku/binding/IdFactory.java
@@ -75,7 +75,7 @@ public class IdFactory {
   /**
    * Don't use this method unless you know exactly what you do !
    * Be sure to use a sufficient large entropy 
-   * @param numberOfBits >=1 (although this small entropy does not make sense)
+   * @param numberOfBits &gt;=1 (although this small entropy does not make sense)
    */
   public void setNumberOfBits(int numberOfBits) {
     if (numberOfBits <1) {
-- 
cgit v1.2.3