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
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/api/WeavingContext.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/api/WeavingContext.java
index 9b8f4f9..07e87ff 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/api/WeavingContext.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/api/WeavingContext.java
@@ -419,6 +419,7 @@
/**
* reload the class dynamically
+ * @param clazz ... the class which needs reloading
*/
public Class reload(Class clazz)
{
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Cast.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Cast.java
index 46dbd83..a3dcd62 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Cast.java
+++ b/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;
}
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/FileUtils.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/FileUtils.java
index 6fa6740..6ae071b 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/FileUtils.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/FileUtils.java
@@ -46,7 +46,7 @@
* <p> </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 @@
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 @@
/**
* fetches the source paths from a given root directory in the format
- * <path>/<appendix>;...
+ * <path>/<appendix>;...
*
* @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
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java
index 888819a..730835d 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java
+++ b/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);
}
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/BaseEngine.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/BaseEngine.java
index cb2b98f..5271ee0 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/BaseEngine.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/BaseEngine.java
@@ -132,7 +132,7 @@
/**
* 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 @@
/**
* checks whether we have resources which are tainted
*
- * @return
+ * @return true if any resource is tainted
*/
public boolean isTainted()
{
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/dependencyScan/registry/DependencyRegistryImpl.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/dependencyScan/registry/DependencyRegistryImpl.java
index 03e1ee8..229ec50 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/dependencyScan/registry/DependencyRegistryImpl.java
+++ b/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 @@
}
/**
- * 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 @@
/**
* flush to flush down our stored dependencies into our final map
+ *
+ * @param engineType the engine type
*/
public void flush(Integer engineType) {
//_registrationStrategy.apply(_dependencies);
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/ClassResource.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/ClassResource.java
index 1e3feac..6bd4836 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/ClassResource.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/ClassResource.java
@@ -86,7 +86,7 @@
/**
* identifier for this resource is the classname
*
- * @return
+ * @return the class name for this resource
*/
public String getIdentifier()
{
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/WatchedResource.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/WatchedResource.java
index 4aff748..671a129 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/WatchedResource.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/monitor/WatchedResource.java
@@ -41,7 +41,7 @@
/**
* Unique identifier on the resource
*
- * @return
+ * @return get the unique idientifier for this resource
*/
public abstract String getIdentifier();
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/reloading/SimpleReloadingStrategy.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/reloading/SimpleReloadingStrategy.java
index 171e18c..e7c1253 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/reloading/SimpleReloadingStrategy.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/reloading/SimpleReloadingStrategy.java
@@ -92,6 +92,7 @@
* 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) {
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/BaseAnnotationScanListener.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/BaseAnnotationScanListener.java
index 37b462c..7a4d011 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/BaseAnnotationScanListener.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/BaseAnnotationScanListener.java
@@ -48,8 +48,7 @@
* 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) {
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/FacesServletMapping.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/FacesServletMapping.java
index bed41df..d996191 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/FacesServletMapping.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/FacesServletMapping.java
@@ -56,7 +56,7 @@
/**
* Creates a new FacesServletMapping object using extension mapping.
*
- * @param path The extension (".jsf", for example) which has been
+ * @param extension The extension (".jsf", for example) which has been
* specified in the url-pattern of the FacesServlet mapping.
* @return a newly created FacesServletMapping
*/
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerImpl.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerImpl.java
index 5188a64..1c6f5e3 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerImpl.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerImpl.java
@@ -115,6 +115,12 @@
* loader. If no library, or resource is found, just return null,
* so the algorithm in createResource can continue checking with the
* next registered ResourceLoader.
+ *
+ * @param resourceLoader the resource loader for this resource
+ * @param resourceName the resource name for this resource
+ * @param libraryName the library name for this resource
+ *
+ * @return the resource meta data for the specifiy resource
*/
protected ResourceMeta deriveResourceMeta(ResourceLoader resourceLoader,
String resourceName, String libraryName)
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerSupport.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerSupport.java
index dc8afca..a319b13 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerSupport.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceHandlerSupport.java
@@ -43,6 +43,9 @@
* /javax.faces.resource/image.jpg
*
* This is used on ResourceHandler.handleResourceRequest()
+ *
+ * @param facesContext the standard faces context
+ * @return the resource base path from a given faces context
*
*/
public abstract String calculateResourceBasePath(FacesContext facesContext);
@@ -52,21 +55,21 @@
* using the standard. The order of ResourceLoaders define
* its precedence.
*
- * @return
+ * @return an array of resource loaders
*/
public abstract ResourceLoader[] getResourceLoaders();
/**
* Check if the mapping used is done using extensions (.xhtml, .jsf)
* or if it is not (/faces/*)
- * @return
+ * @return true if the mapping is done with extensions
*/
public abstract boolean isExtensionMapping();
/**
* Get the mapping used as prefix(/faces) or sufix(.jsf)
*
- * @return
+ * @return the defined mapping for triggering the faces servlet
*/
public abstract String getMapping();
@@ -74,14 +77,14 @@
* Return the time when the app started. This is useful to set the
* "Last-Modified" header in some specific cases.
*
- * @return
+ * @return the startup time as long value
*/
public abstract long getStartupTime();
/**
* Return the time that should be set on "Expires" header in a resource.
*
- * @return
+ * @return the max time expires value as long
*/
public abstract long getMaxTimeExpires();
}
diff --git a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceLoader.java b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceLoader.java
index d14cf66..2c6eca0 100644
--- a/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceLoader.java
+++ b/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/ResourceLoader.java
@@ -42,25 +42,56 @@
_prefix = prefix;
}
+ /**
+ * Gets the resource version of a specifiy resource
+ *
+ * @param path the resource path
+ * @return the version of the resource as String
+ */
public abstract String getResourceVersion(String path);
/**
* Return the max available version found (if exists) or
- * return null if no version available.
+ * return null if no version available.
+ *
+ * @param path the path to the library
+ * @return the available version or null
*/
public abstract String getLibraryVersion(String path);
/**
- * Return the max available version found (if exists) or
- * return null if no version available.
+ * Return the resourource url from the given meta data
+ *
+ * @param resourceMeta the resource metadata
+ * @return the resourource url from the given meta data
*/
public abstract URL getResourceURL(ResourceMeta resourceMeta);
+ /**
+ * Returns an input stream on a given resource defined by resource meta
+ *
+ * @param resourceMeta the resource metadata
+ * @return an input stream on the given resource
+ */
public abstract InputStream getResourceInputStream(ResourceMeta resourceMeta);
-
+
+ /**
+ * creates a resource meta data object
+ * @param prefix the prefix for the resource
+ * @param libraryName the library name
+ * @param libraryVersion the library version
+ * @param resourceName the resource name
+ * @param resourceVersion and the version
+ * @return a ResourceMeta object of the information passed to this method
+ */
public abstract ResourceMeta createResourceMeta(String prefix, String libraryName, String libraryVersion,
String resourceName, String resourceVersion);
-
+
+ /**
+ * checks if the library exists
+ * @param libraryName the library name to check for
+ * @return true if it exists
+ */
public abstract boolean libraryExists(String libraryName);
private Comparator<String> _versionComparator = null;
@@ -79,9 +110,15 @@
_versionComparator = versionComparator;
}
- public class VersionComparator implements Comparator<String>
+ protected class VersionComparator implements Comparator<String>
{
+ /**
+ * Standard comoare method
+ * @param s1 string1 to compare
+ * @param s2 string2 to compare
+ * @return standard numeric compare result
+ */
public int compare(String s1, String s2)
{
int n1 = 0;
@@ -143,12 +180,20 @@
return n1 - n2;
}
}
-
+
+ /**
+ * getter for the standard resource loader prefix
+ * @return the resource loader prefix
+ */
public String getPrefix()
{
return _prefix;
}
+ /**
+ * setter for the prefix
+ * @param prefix the prefix satring used for the resource loader
+ */
public void setPrefix(String prefix)
{
_prefix = prefix;
