deegree#899 fixed javadoc and site generation

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/concurrent/ExecutionFinishedEvent.java

@@ -40,19 +40,16 @@
 
 /**
  * Event that is sent when an asynchronous task finished.
- * <p>
+ * <br/>
  * This can mean:
  * <ul>
  * <li>it finished successfully</li>
  * <li>it terminated abnormally (with an exception or error)</li>
  * <li>a time out occurred during the performing of the task (or it's thread has been cancelled)</li>
  * </ul>
- * </p>
- * <p>
  * If the task did not finish successfully, the thrown exception / error is rethrown when {@link #getResult()} is
  * called.
- * </p>
- * 
+ *
  * @param <T>
  *            type of return value
  * 

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/index/QTree.java

@@ -790,7 +790,7 @@ public boolean equals( Object other ) {
          * Combining the hash code(s) computed above: result = 37 * result + code;
          * </p>
          * 
-         * @return (int) ( result >>> 32 ) ^ (int) result;
+         * @return (int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;
          * 
          * @see java.lang.Object#hashCode()
          */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/jdbc/SQLIdentifier.java

@@ -37,8 +37,8 @@
 
 /**
  * An SQL identifier (e.g. a table, column or sequence name) with optional qualifier and optional escaping.
- * <p>
- * <h4>Qualification</h4>
+ * <br/>
+ * <h3>Qualification</h3>
  * Each identifier consists of a name part and an optional qualifier part and has the syntax
  * <code>(qualifier.)* name</code>. Examples:
  * <ul>
@@ -48,7 +48,7 @@
  * <li><code>mytable.mycolumn</code></li>
  * <li><code>myschema.mytable.mycolumn</code></li>
  * </ul>
- * <h4>Escaping</h4>
+ * <h3>Escaping</h3>
  * Escaping an identifier has two effects (TODO verify on all DBMS): it allows to use normally reserved characters/words
  * and tells the DBMS to treat the identifier in a case-sensitive manner. However, different DBMSs use different ways to
  * mark an escaped identifier, e.g. for table names:
@@ -58,8 +58,7 @@
  * <li>SQL Server uses brackets: [escaped table name] (needs verification)</li>
  * <li>MySQL uses ticks: `escaped table name` (needs verification)</li>
  * </ul>
- * </p>
- * 
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
  * @author last edited by: $Author$
  * 

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/ows/metadata/party/ResponsibleParty.java

@@ -40,14 +40,13 @@
 /**
  * Encapsulates information on the identification of, and the means of communication with the person/party responsible
  * for the server.
- * <p>
+ * <br/>
  * Data model has been carefully designed to capture the expressiveness of all OWS specifications and versions and was
  * verified for the following specifications:
  * <ul>
  * <li>OWS Common 2.0</li>
  * </ul>
- * </p>
- * 
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
  * @author <a href="mailto:ionita@lat-lon.de">Andrei Ionita</a>
  * @author last edited by: $Author$

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/tom/ElementNode.java

@@ -45,18 +45,16 @@
 
 /**
  * {@link TypedObjectNode} with an (XML) element semantic.
- * <p>
- * Chararacteristics:
+ * Characteristics:
  * <ul>
  * <li>Element name</li>
  * <li>Attributes</li>
  * <li>Child nodes</li>
- * </p>
- * 
+ * </ul>
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
  * @author <a href="mailto:schmitz@lat-lon.de">Andreas Schmitz</a>
- * @author last edited by: $Author$
- * 
+ *
  * @version $Revision$, $Date$
  */
 public interface ElementNode extends TypedObjectNode {

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/tom/datetime/ISO8601Converter.java

@@ -101,7 +101,7 @@ public static Date parseDate( final String xsDate )
      * Parses the given <code>xs:time</code> string.
      * 
      * @param xsTime
-     *            the <code>xs:time/code> to be parsed, must not be <code>null</code>
+     *            the <code>xs:time</code> to be parsed, must not be <code>null</code>
      * @return the parsed date, never <code>null</code> (available timezone information is kept)
      * @throws IllegalArgumentException
      *             if parameter does not conform to lexical value space defined in XML Schema Part 2: Datatypes for

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/tom/ows/StringOrRef.java

@@ -114,7 +114,7 @@ public boolean equals( Object o ) {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
+     * @return (int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;
      * 
      * @see java.lang.Object#hashCode()
      */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/tom/sql/SQLValueMangler.java

@@ -60,7 +60,7 @@ public class SQLValueMangler {
     /**
      * Converts the given {@link PrimitiveValue} value to the corresponding SQL object type.
      * 
-     * @param value
+     * @param pv
      * @return
      */
     public static Object internalToSQL( PrimitiveValue pv ) {

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/uom/Measure.java

@@ -136,7 +136,7 @@ public boolean equals( Object obj ) {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
+     * @return <code>(int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;</code>
      * 
      * @see java.lang.Object#hashCode()
      */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/Pair.java

@@ -108,7 +108,7 @@ public boolean equals( Object other ) {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
+     * @return (int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;
      * 
      * @see java.lang.Object#hashCode()
      */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/Triple.java

@@ -104,7 +104,7 @@ public boolean equals( Object other ) {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
+     * @return <code>(int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;</code>
      * 
      * @see java.lang.Object#hashCode()
      */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/io/Utils.java

@@ -64,7 +64,6 @@ public void write( int b )
      * @param in1
      * @param in2
      * @return the percentage (0..1)
-     * @throws IOException
      */
     public static double determineSimilarity( RenderedImage in1, RenderedImage in2 ) {
         Raster data1 = in1.getData();

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/kvp/KVPUtils.java

@@ -340,13 +340,12 @@ public static BigInteger getBigInt( Map<String, String> kvpParams, String paramN
      * <li>Keys are uppercased.</li>
      * <li>Values are URL decoded.</li>
      * </ul>
-     * </p>
-     * 
+     *
      * @param url
      *            url of the text file
-     * @return map with the contents of the file, keys are uppercased
+     * @return map with the contents of the file, keys are uppercase
      * @throws IOException
-     *             if the the file cannot be loaded
+     *             if the file cannot be loaded
      */
     public static Map<String, String> readFileIntoMap( URL url )
                             throws IOException {

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/math/Vectors3d.java

@@ -227,7 +227,7 @@ public final static void normal( double[] a, int index, double[] result ) {
      * vector will be returned .
      * 
      * @param a
-     *            array containing the ordinates of the vectors with length > index + 9
+     *            array containing the ordinates of the vectors with length > index + 9
      * @param index
      *            index of the first vector
      * @return a new allocated array with length 3 containing the normalized normal vector.
@@ -264,7 +264,7 @@ public final static double[] normalizedNormal( double[] a, int ia, int ib, int i
      * the (unnormalized) vector will be returned .
      * 
      * @param a
-     *            array containing the ordinates of the vectors with length > index + 9
+     *            array containing the ordinates of the vectors with <code>length &gt; index + 9</code>
      * @param index
      *            index of the first vector
      * @param result

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/math/Vectors3f.java

@@ -163,7 +163,7 @@ public final static String asString( float[] a ) {
      * store the result in a new allocated array with length 3.
      * 
      * @param a
-     *            array with length > index + 9
+     *            array with <code>length &gt; index + 9</code>
      * @param index
      *            index of the first vector
      * @return a newly allocated array with length 3 containing the normal vector.
@@ -240,13 +240,12 @@ public final static void normal( float[] a, int ia, int ib, int ic, float[] resu
      * store the result in given array with length 3.
      * 
      * @param a
-     *            an array containing the ordinates of the vectors with length > index + 9
+     *            an array containing the ordinates of the vectors with length &gt; index + 9
      * @param index
      *            index of the first vector
      * @param result
      *            array with length 3
-     * @throws IndexOutOfBoundsException
-     *             if a.length < index +9
+     * @throws IndexOutOfBoundsException if <code>a.length &lt; index + 9</code>
      */
     public final static void normal( float[] a, int index, float[] result ) {
         normal( a, index, index + 3, index + 6, result );
@@ -259,7 +258,7 @@ public final static void normal( float[] a, int index, float[] result ) {
      * vector will be returned .
      * 
      * @param a
-     *            array containing the ordinates of the vectors with length > index + 9
+     *            array containing the ordinates of the vectors with <code>length &gt; index + 9</code>
      * @param index
      *            index of the first vector
      * @return a new allocated array with length 3 containing the normalized normal vector.
@@ -296,7 +295,7 @@ public final static float[] normalizedNormal( float[] a, int ia, int ib, int ic
      * the (unnormalized) vector will be returned .
      * 
      * @param a
-     *            array containing the ordinates of the vectors with length > index + 9
+     *            array containing the ordinates of the vectors with <code>length &gt; index + 9</code>
      * @param index
      *            index of the first vector
      * @param result

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/net/HttpUtils.java

@@ -95,7 +95,7 @@
  * 
  * <code>
  * var u = org.deegree.commons.utils.net.HttpUtils
- * u.retrieve(u.UTF8STRING, "http://demo.deegree.org/deegree-wms/services?request=capabilities&service=WMS")
+ * u.retrieve(u.UTF8STRING, "http://demo.deegree.org/deegree-wms/services?request=capabilities&amp;service=WMS")
  * </code>
  * 
  * @author <a href="mailto:schmitz@lat-lon.de">Andreas Schmitz</a>

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/nio/PooledByteBuffer.java

@@ -205,7 +205,7 @@ public boolean equals( Object other ) {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
+     * @return <code>(int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;</code>
      * 
      * @see java.lang.Object#hashCode()
      */

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/utils/test/TestProperties.java

@@ -76,7 +76,7 @@ public class TestProperties {
     /**
      * Returns the properties from <code>${user.home}/.deegree-test.properties</code>.
      * 
-     * @return the properties, can be empty, but never <code>null/<code>
+     * @return the properties, can be empty, but never <code>null</code>
      */
     public static Properties getProperties() {
         return props;

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/xml/XMLAdapter.java

@@ -88,7 +88,7 @@
  * <code>XMLAdapter</code> is the common base class of all hand-written (i.e. not automatically generated) XML parsers
  * and exporters in deegree. Classes that extend <code>XMLAdapter</code> provide the binding between a certain type of
  * XML documents and their corresponding Java bean representation.
- * <p>
+ * <br/>
  * <code>XMLAdapter</code> tries to make the process of writing custom XML parsers as painless as possible. It provides
  * the following functionality:
  * <ul>
@@ -103,12 +103,10 @@
  * <li>Resolving of relative URLs that occur in the document content, i.e. that refer to resources that are located
  * relative to the document.</li>
  * </ul>
- * </p>
- * <p>
+ * <br/>
  * Technically, the XML handling is based on <a href="http://ws.apache.org/commons/axiom/">AXIOM (AXis Object
  * Model)</a>.
- * </p>
- * 
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider </a>
  * @author last edited by: $Author$
  * 
@@ -1216,7 +1214,7 @@ public static void writeElement( XMLStreamWriter writer, String namespace, Strin
      * @param value
      *            the text value of the element
      * @param attrNS
-     *            the namespace of the attribute, <code>null</null> if the local namespace of the element should be used
+     *            the namespace of the attribute, <code>null</code> if the local namespace of the element should be used
      * @param attribPRE
      *            to use for the namespace binding
      * @param attrName
@@ -1309,7 +1307,7 @@ public static void writeOptionalNSAttribute( XMLStreamWriter writer, String name
      * @param elemName
      *            the element name
      * @param attrNS
-     *            the namespace of the attribute, <code>null</null> if the local namespace of the element should be used
+     *            the namespace of the attribute, <code>null</code> if the local namespace of the element should be used
      * @param attrName
      *            the attribute name
      * @param attrValue

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/xml/schema/SchemaValidator.java

@@ -67,17 +67,15 @@
  * Provides utility methods for the easy validation of XML instance documents against XML schemas and for the validation
  * of XML schema documents.
  * <p>
- * <h4>Validation of instance documents</h4>
+ * <h3>Validation of instance documents</h3>
  * The XML schemas are either determined from the <code>xsi:schemaLocation</code> attribute of the document or may be
  * explicitly specified. The validator uses the {@link RedirectingEntityResolver}, so OGC core schemas are not fetched
  * over the network, but loaded from a local copy.
  * </p>
- * <p>
- * <h4>Validation of schema documents</h4>
+ * <h3>Validation of schema documents</h3>
  * The validator uses the {@link RedirectingEntityResolver}, so OGC core schemas are not fetched over the network, but
  * loaded from a local copy.
- * </p>
- * 
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
  * @author last edited by: $Author: schneider $
  * 

deegree-core/deegree-core-commons/src/main/java/org/deegree/commons/xml/stax/NamespaceNormalizingXMLStreamWriter.java

@@ -45,16 +45,15 @@
 
 /**
  * {@link XMLStreamWriter} that performs normalization of namespace bindings.
- * <p>
+ *
  * Performed normalizations:
  * <ul>
  * <li><b>Prefixes</b>: The given namespace-prefix bindings take precedence over the prefixes specified when writing
  * namespaces.</li>
  * <li><b>Removal of redundant bindings</b>: If a namespace prefix is already bound (to the same namespace) at a certain
  * position in the document, subsequent (redundant) bindings are skipped.</li>
  * </ul>
- * </p>
- * 
+ *
  * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
  * @author last edited by: $Author$
  * 

deegree-core/deegree-core-workspace/src/main/java/org/deegree/workspace/standard/DefaultResourceIdentifier.java

@@ -89,8 +89,8 @@ public Class<? extends ResourceProvider<T>> getProvider() {
      * Combining the hash code(s) computed above: result = 37 * result + code;
      * </p>
      * 
-     * @return (int) ( result >>> 32 ) ^ (int) result;
-     * 
+     * @return <code>(int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;</code>
+     *
      * @see java.lang.Object#hashCode()
      */
     @Override

deegree-services/deegree-services-wpvs/src/main/java/org/deegree/services/wpvs/config/Dataset.java

@@ -310,7 +310,7 @@ public boolean equals( Object other ) {
          * Combining the hash code(s) computed above: result = 37 * result + code;
          * </p>
          * 
-         * @return (int) ( result >>> 32 ) ^ (int) result;
+         * @return (int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;
          * 
          * @see java.lang.Object#hashCode()
          */

deegree-services/deegree-services-wpvs/src/main/java/org/deegree/services/wpvs/rendering/jogl/GLPBufferPool.java

@@ -262,7 +262,7 @@ private static class PBufferKey {
          * Combining the hash code(s) computed above: result = 37 * result + code;
          * </p>
          * 
-         * @return (int) ( result >>> 32 ) ^ (int) result;
+         * @return (int) ( result &gt;&gt;&gt; 32 ) ^ (int) result;
          * 
          * @see java.lang.Object#hashCode()
          */