You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by we...@apache.org on 2017/09/24 19:34:46 UTC
svn commit: r1809542 - in /myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting: core/common/util/ core/engine/api/ jsf/annotation/ jsf/resources/deprecated/

Author: werpu
Date: Sun Sep 24 19:34:46 2017
New Revision: 1809542

URL: http://svn.apache.org/viewvc?rev=1809542&view=rev
Log:
 EXTSCRIPT-189: fix a lot of jsdoc warnings

Modified:
    myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java
    myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/CompilationResult.java
    myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/ScriptingEngine.java
    myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/GenericAnnotationScanner.java
    myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/BaseResourceHandlerSupport.java

Modified: myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java?rev=1809542&r1=1809541&r2=1809542&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java (original)
+++ myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/common/util/Null.java Sun Sep 24 19:34:46 2017
@@ -29,7 +29,7 @@ public class Null extends Cast
 
     /**
      * representation of a null value of a specific class
-     * @param clazz
+     * @param clazz the class for the null representation
      */
     public Null(Class clazz) {
         super(clazz, null);

Modified: myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/CompilationResult.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/CompilationResult.java?rev=1809542&r1=1809541&r2=1809542&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/CompilationResult.java (original)
+++ myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/CompilationResult.java Sun Sep 24 19:34:46 2017
@@ -55,6 +55,7 @@ public class CompilationResult {
      * @param compilerOutput the compiler output, i.e. simply everything that the compiler would
      *                       usually print to the console, if you executed the same process on
      *                       the command line instead
+     *
      */
     public CompilationResult(String compilerOutput) {
         this._compilerOutput = compilerOutput;
@@ -80,7 +81,7 @@ public class CompilationResult {
      * <p>Determines whether any error messages have been registered, i.e. whether compilation
      * was successful.</p>
      *
-     * @return <code>true</code if no error messages have been registered, i.e. if compilation
+     * @return <code>true</code> if no error messages have been registered, i.e. if compilation
      *         was sucessful; <code>false</code> otherwise
      */
     public boolean hasErrors() {

Modified: myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/ScriptingEngine.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/ScriptingEngine.java?rev=1809542&r1=1809541&r2=1809542&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/ScriptingEngine.java (original)
+++ myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/core/engine/api/ScriptingEngine.java Sun Sep 24 19:34:46 2017
@@ -49,7 +49,7 @@ public interface ScriptingEngine
 
     /**
      * returns the file ending sufficient for this engine
-     * @return
+     * @return the correct file ending for the engine
      */
     public String getFileEnding();
 
@@ -61,18 +61,22 @@ public interface ScriptingEngine
 
     /**
      * runs the compile cycle for this engine
+     *
+     * @return a compilation result for this compile
      */
     public CompilationResult compile();
 
     /**
      * checks if the current engine has tainted classes
-     * @return
+     *
+     * @return true if a resource is tainted
      */
     public boolean isTainted();
 
     /**
      * checks if the current engine has a need for a recompile of certain classes
-     * @return
+     *
+     * @return true if the engine needs a recompile
      */
     public boolean needsRecompile();
 
@@ -120,7 +124,7 @@ public interface ScriptingEngine
 
     /**
      * detects whether a given object is an artifact of a given object
-     * @return
+     * @return true if this artifact belongs to the engine
      */
     public boolean isArtifactOfEngine(Object artifact);
 

Modified: myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/GenericAnnotationScanner.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/GenericAnnotationScanner.java?rev=1809542&r1=1809541&r2=1809542&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/GenericAnnotationScanner.java (original)
+++ myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/annotation/GenericAnnotationScanner.java Sun Sep 24 19:34:46 2017
@@ -44,7 +44,7 @@ import java.util.logging.Logger;
  *          <p>&nbsp;</p>
  *          Source path annotation scanner for java it scans all sources in the specified source paths
  *          recursively for additional information
- *          and then adds the id/name -> class binding information to the correct factory locations,
+ *          and then adds the id/name -&gt; class binding information to the correct factory locations,
  *          wherever possible
  */
 @SuppressWarnings("unused")

Modified: myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/BaseResourceHandlerSupport.java
URL: http://svn.apache.org/viewvc/myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/BaseResourceHandlerSupport.java?rev=1809542&r1=1809541&r2=1809542&view=diff
==============================================================================
--- myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/BaseResourceHandlerSupport.java (original)
+++ myfaces/extensions/scripting/trunk/extscript-core-root/extscript-core/src/main/java/org/apache/myfaces/extensions/scripting/jsf/resources/deprecated/BaseResourceHandlerSupport.java Sun Sep 24 19:34:46 2017
@@ -143,6 +143,9 @@ public class BaseResourceHandlerSupport
     /**
      * Read the web.xml file that is in the classpath and parse its internals to
      * figure out how the FacesServlet is mapped for the current webapp.
+     *
+     * @param context standard faces context
+     * @return the servlet mapping
      */
     protected FacesServletMapping getFacesServletMapping(FacesContext context)
     {