javadoc corrections

Author: verhas

pom.xml

@@ -72,12 +72,12 @@
                             <reports>
                             </reports>
                         </plugin>
+                        -->
                         <plugin>
                             <groupId>org.apache.maven.plugins</groupId>
                             <artifactId>maven-javadoc-plugin</artifactId>
                             <version>2.7</version>
                         </plugin>
-                        -->
                     </reportPlugins>
                 </configuration>
             </plugin>

src/main/java/com/scriptbasic/interfaces/InterpreterHook.java

@@ -24,7 +24,7 @@
  * parameter <i>N</i> should run from 0 ... and the hooks will be registered in
  * the order they are numbered and executed in backward order. To use the hook
  * delivered with jScriptBasic you should configure:
- * <p>
+ * </p>
  * <pre>
  * hook.0=com.scriptbasic.hooks.RunLimitHook
  * </pre>

src/main/java/com/scriptbasic/interfaces/MethodRegistry.java

@@ -3,12 +3,13 @@
 import java.lang.reflect.Method;
 
 /**
+ * <p>
  * Keep a registry of methods. The Java methods (either class or object method)
  * can be called from interpreted script. The problem is that Java methods can
  * be overloaded and BASIC functions can not. To overcome this issue the BASIC
  * program has to declare a function name for each method it wants to call. For
  * example:
- * <p>
+ * </p>
  * <pre>
  * method sin from java.lang.Math is (double) use as sinus
  * </pre>
@@ -19,31 +20,35 @@
  * the method will be used as the name of the BASIC function and no alias is
  * used. If this part is defined then the alias will be used as the name of the
  * function.
+ * </p>
  * <p>
  * If there are two methods of the same name, with different signature, you have
  * to define different aliases for the different methods.
+ * </p>
  * <p>
  * You can use the same alias for different methods in different packages. This
  * can be done because the class name or alias for the class name or the
  * variable holding the Java object reference stands in front of the method
  * name/alias when the registered method is called. This distinguishes the
  * different methods of different class even if the aliases or the method names
  * are the same.
+ * </p>
  * <p>
  * Also note that you can also use aliases for Class names defined in the
  * statement {@code use}.
- * <p>
+ * </p>
  * The registry keeps track of the
  * <ul>
  * <li>name of the method,  
  * <li>the alias,
  * <li>the class and
  * <li>the signature.
  * </ul>
+ * <p>
  * Thus whenever there is a function call in BASIC to call a Java method in a
  * certain class this registry will know which signature to use for the certain
  * alias.
- * <p>
+ * </p>
  * Aliases can be global or class specific. When an alias is defined for a
  * single method then the alias can be used without the class specification.
  * This appears in the BASIC code as a simple function call. When a method is

src/main/java/com/scriptbasic/interfaces/NoAccessProxy.java

@@ -7,7 +7,7 @@
  * can be embedded in a {@code NoAccessProxy}. Since this proxy implements the NoAccess interface the BASIC program
  * will not be able to access the field 'target'.
  *
- * @param <T>
+ * @param <T> the type of the object that can not be accessed by the BASIC program
  */
 public class NoAccessProxy<T> implements NoAccess {
     public T target;

src/main/java/com/scriptbasic/interfaces/SourceLocationBound.java

@@ -6,7 +6,7 @@
  * line number and the character position on that line.
  *
  * @author Peter Verhas
- * @date June 15, 2012
+ * June 15, 2012
  */
 public interface SourceLocationBound {
     /**

src/main/java/com/scriptbasic/syntax/expression/BasicTagAnalyzer.java

@@ -20,7 +20,7 @@
  * brackets some way).
  * <p>
  * A tag is defined as the following:
- * <p>
+ * </p>
  * <pre>
  *  tag ::= UNOP tag
  *          TRUE | FALSE

src/main/java/com/scriptbasic/utility/KlassUtility.java

@@ -81,7 +81,7 @@ public static void setField(Object object, String fieldName,
      * @param object
      * @param fieldName
      * @return
-     * @throws ExecutionException
+     * @throws BasicRuntimeException
      */
     public static Object getField(Object object, String fieldName)
             throws BasicRuntimeException {

src/main/java/com/scriptbasic/utility/NumberUtility.java

@@ -53,7 +53,7 @@ public static boolean isPositive(Number a) {
      *
      * @param a one of the numbers
      * @param b the other number
-     * @return 0 if a == b; 1 if a > b; and -1 if b < a
+     * @return 0 if a == b; 1 if a &gt; b; and -1 if b &lt; a
      */
     public static int compare(Number a, Number b) {
         if (a == null && b == null) {

src/main/java/com/scriptbasic/utility/functions/StringFunctions.java

@@ -3,19 +3,20 @@
 import com.scriptbasic.api.BasicFunction;
 
 /**
+ * <p>
  * This class implements string functions for the BASIC interpreter. Most of the
  * methods implement a wrapper for the method of the same name in the class
  * {@code java.lang.String}. These methods in the class {@code java.lang.String}
  * are not static and therefore need a String object to work on. The wrapper
  * methods are static and take the first argument as the String object to work
  * on. In other words if in Java you would write
- * <p>
+ * </p>
  * <pre>
  * s.xyz(parameterlist)
  * </pre>
  * <p>
  * to call the method {@code xyz()} then in BASIC you will be able to call
- * <p>
+ * </p>
  * <pre>
  * xyz(s, parameterlist)
  * </pre>
@@ -24,7 +25,7 @@
  * not repeated here. Other methods, that implement BASIC like string functions
  * not implemented in the class {@code java.lang.String} are documented in this
  * class.
- *
+ * </p>
  * @author Peter Verhas
  */
 public class StringFunctions {