EXTSCRIPT-189: fix a lot of jsdoc warnings

git-svn-id: https://svn.apache.org/repos/asf/myfaces/extensions/scripting/trunk@1809541 13f79535-47bb-0310-9956-ffa450edef68

Author: werpu

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/api/WeavingContext.java

@@ -419,6 +419,7 @@ public Class forName(String name) {
 
     /**
      * reload the class dynamically
+     * @param clazz ... the class which needs reloading
      */
     public Class reload(Class clazz)
     {

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Cast.java

@@ -21,21 +21,36 @@
 /**
  * Simple casting representation for introspection
  * calls
+ *
+ * @author Werner Punz
  */
 public class Cast {
 
     Class clazz;
     Object value;
 
+    /**
+     *
+     * @param clazz the cast class representing the value
+     * @param value the value itself
+     */
     public Cast(Class clazz, Object value) {
         this.clazz = clazz;
         this.value = value;
     }
 
+    /**
+     * standard getter
+     * @return the cast class representing the value
+     */
     public Class getClazz() {
         return clazz;
     }
 
+    /**
+     * standard getter
+     * @return the value itself
+     */
     public Object getValue() {
         return value;
     }

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/FileUtils.java

@@ -46,7 +46,7 @@ public static String getFileSeparator() {
      * <p>&nbsp;</p>
      * the touch is basically just the same as unix touch
      *
-     * @param fileToTouch
+     * @param fileToTouch the file which needs unix style touching
      */
     public static void touch(File fileToTouch) {
         //we change our lastMofied to the current system time
@@ -72,6 +72,10 @@ public static String getFileSeparatorForRegex() {
         return sep;
     }
 
+    /**
+     * Gets a temp dir to work on
+     * @return a temp dir which can be used for io processing
+     */
     public static File getTempDir() {
         File tempDir;
 
@@ -183,7 +187,7 @@ public static List<File> fetchSourceFiles(Collection<String> sourcePaths, String
 
     /**
      * fetches the source paths from a given root directory in the format
-     * <path>/<appendix>;...
+     * &lt;path&gt;/&lt;appendix&gt;;...
      *
      * @param sourcePath the sourcePath from which the directory traversal should happen from
      * @param appendix   the appendix which has to be appended to every path found

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java

@@ -19,12 +19,18 @@
 package org.apache.myfaces.extensions.scripting.core.common.util;
 
 /**
- * @Author Werner Punz
+ * @author Werner Punz
  * Null representation for easier introspection calls
+ *
+ * @author Werner Punz
  */
 public class Null extends Cast
 {
 
+    /**
+     * representation of a null value of a specific class
+     * @param clazz
+     */
     public Null(Class clazz) {
         super(clazz, null);
     }

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/BaseEngine.java

@@ -132,7 +132,7 @@ public void scanForAddedDeleted()
     /**
      * checks whether we have resources which are in need of a recompile
      *
-     * @return
+     * @return true if a recompile is needed
      */
     public boolean needsRecompile()
     {
@@ -147,7 +147,7 @@ public boolean needsRecompile()
     /**
      * checks whether we have resources which are tainted
      *
-     * @return
+     * @return true if any resource is tainted
      */
     public boolean isTainted()
     {

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/dependencyScan/registry/DependencyRegistryImpl.java

@@ -32,6 +32,8 @@
 
 /**
  * registry facade which is used to track our dependencies
+ *
+ * @author Werner Punz
  */
 public class DependencyRegistryImpl implements ExternalFilterDependencyRegistry
 {
@@ -95,7 +97,7 @@ public boolean isAllowed(Integer engineType, String className) {
     }
 
     /**
-     * adds a dependency to our dependency map (usually rootclass -> dependency and currentClass -> dependency)
+     * adds a dependency to our dependency map (usually rootclass -> dependency and currentClass -> dependency)
      *
      * @param engineType            the engine type for this dependency
      * @param rootClass             the root class of this scan which all dependencies are referenced from
@@ -134,6 +136,8 @@ public void addDependency(Integer engineType, String rootClass, String currently
 
     /**
      * flush to flush down our stored dependencies into our final map
+     *
+     * @param engineType the engine type
      */
     public void flush(Integer engineType) {
         //_registrationStrategy.apply(_dependencies);

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/ClassResource.java

@@ -86,7 +86,7 @@ public String getSourceDir()
     /**
      * identifier for this resource is the classname
      *
-     * @return
+     * @return the class name for this resource
      */
     public String getIdentifier()
     {

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/WatchedResource.java

@@ -41,7 +41,7 @@ public abstract class WatchedResource implements Cloneable {
     /**
      * Unique identifier on the resource
      *
-     * @return
+     * @return get the unique idientifier for this resource
      */
     public abstract String getIdentifier();
 

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/reloading/SimpleReloadingStrategy.java

@@ -92,6 +92,7 @@ public Object reload(Object scriptingInstance, int engineType, int artifactType)
      * which have to preserve some kind of delegate before instantiation.
      *
      * @param target the target which has to receive the properties
+     * @param engineType the engine type for the mapping
      * @param src    the source which has the original properties
      */
     protected void mapProperties(Object target, int engineType, Object src) {

extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/BaseAnnotationScanListener.java

@@ -48,8 +48,7 @@ protected Application getApplication() {
      * unregisters this class in the central registry
      * is triggered if the class itself has been registered previously
      *
-     * @param className
-     * @return
+     * @param className the classname which should be unregistered
      */
     public void purge(String className) {