ICEfaces
  1. ICEfaces
  2. ICE-11206

Resolve ICEfaces JavaDoc failures when generating with JDK 1.8

    Details

    • Affects:
      Documentation (User Guide, Ref. Guide, etc.), Compatibility/Configuration

      Description

      When attempting to build ICEfaces 4.x using JDK 1.8, numerous JavaDoc failures that used to be warnings, but are now fatal cause the build to be aborted.

      When using ANT, http://jira.icesoft.org/browse/ICE-11098 established a technique for avoiding the fatal failures with 1.8. However, this technique does not work with our existing Maven-based build.

      In any event, it would be better to resolve the underlying JavaDoc errors themselves.

        Activity

        Hide
        Ken Fyten added a comment -

        The following errors are logged when attempting a "mvn deploy -Djarsigner.skip=true -DdeployRemote=false" build in the /icefaces directory:

         [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.8.1:jar (attach-javadocs) on project icefaces: MavenReportException: Error while creating archive:
        [ERROR] Exit code: 1 - /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:33: warning: no @param for group
        [ERROR] void render(String group);
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:39: warning: no @param for group
        [ERROR] void render(String group, PushOptions options);
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:39: warning: no @param for options
        [ERROR] void render(String group, PushOptions options);
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/ProductInfo.java:75: warning: no description for @return
        [ERROR] * @return
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/ResourceRegistry.java:232: warning: no @param for resource
        [ERROR] public static String addResource(Map scopeMap, Resource resource)  {
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/bean/ViewRetained.java:27: error: unexpected end tag: </p>
        [ERROR] * will be propagated across navigations to the same view ID.</p>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/bean/WindowScopeBeanLocator.java:36: error: @param name not found
        [ERROR] * @param session servlet session
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:28: warning: no @return
        [ERROR] public BrowserType browser();
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:37: warning: no @return
        [ERROR] public String name();
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:47: warning: no @return
        [ERROR] public String library() default "";
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:60: warning: no @return
        [ERROR] public String target() default "";
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:44: warning: no @return
        [ERROR] public BrowserType browser() default BrowserType.ALL;
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:34: warning: no @return
        [ERROR] public ICEBrowserDependency[] browserOverride() default {};
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:63: warning: no @return
        [ERROR] public String library() default "";
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:53: warning: no @return
        [ERROR] public String name() default "";
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:76: warning: no @return
        [ERROR] public String target() default "";
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/ClientDescriptor.java:312: error: bad use of '>'
        [ERROR] * ICE-10828 note that IF4 does not support iOS4, so just assume if iOS it is now > iOS4 and has
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/ClientDescriptor.java:314: warning: no description for @return
        [ERROR] * @return
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:388: error: malformed HTML
        [ERROR] * and works together with the 'ariaEnabled' attribute of the ICEfaces configuration tag <ice:config> so that ARIA support
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:388: error: bad use of '>'
        [ERROR] * and works together with the 'ariaEnabled' attribute of the ICEfaces configuration tag <ice:config> so that ARIA support
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:417: error: malformed HTML
        [ERROR] * together with the render attribute of the ICEfaces configuration tag <ice:config> so that DOM updates can be turned on
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:417: error: bad use of '>'
        [ERROR] * together with the render attribute of the ICEfaces configuration tag <ice:config> so that DOM updates can be turned on
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:430: error: malformed HTML
        [ERROR] * together with the compressIDs attribute of the ICEfaces configuration tag <ice:config> so that ID
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:430: error: bad use of '>'
        [ERROR] * together with the compressIDs attribute of the ICEfaces configuration tag <ice:config> so that ID
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:448: error: self-closing element not allowed
        [ERROR] * <p/>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:465: warning: no description for @param
        [ERROR] * @param value
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:498: error: self-closing element not allowed
        [ERROR] * <p/>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:555: error: self-closing element not allowed
        [ERROR] * <p/>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:557: error: malformed HTML
        [ERROR] * configuration tag <ice:config> so that ICEpush can be set to activate lazily on a per-page basis.
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:557: error: bad use of '>'
        [ERROR] * configuration tag <ice:config> so that ICEpush can be set to activate lazily on a per-page basis.
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:619: error: self-closing element not allowed
        [ERROR] * <p/>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:634: error: self-closing element not allowed
        [ERROR] * <p/>
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:1039: warning: no description for @param
        [ERROR] * @param value
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:187: error: @param name not found
        [ERROR] * @param userAgent
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:187: warning: no description for @param
        [ERROR] * @param userAgent
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:203: error: @param name not found
        [ERROR] * @param userAgent
        [ERROR] ^
        [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:203: warning: no description for @param
        [ERROR] * @param userAgent
        [ERROR] ^
        [ERROR] 
        [ERROR] Command line was: /Library/Java/JavaVirtualMachines/jdk1.8.0_92.jdk/Contents/Home/bin/javadoc @options @packages
        [ERROR]   
        Show
        Ken Fyten added a comment - The following errors are logged when attempting a "mvn deploy -Djarsigner.skip=true -DdeployRemote=false" build in the /icefaces directory: [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.8.1:jar (attach-javadocs) on project icefaces: MavenReportException: Error while creating archive: [ERROR] Exit code: 1 - /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:33: warning: no @param for group [ERROR] void render( String group); [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:39: warning: no @param for group [ERROR] void render( String group, PushOptions options); [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/PortableRenderer.java:39: warning: no @param for options [ERROR] void render( String group, PushOptions options); [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/ProductInfo.java:75: warning: no description for @ return [ERROR] * @ return [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/application/ResourceRegistry.java:232: warning: no @param for resource [ERROR] public static String addResource(Map scopeMap, Resource resource) { [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/bean/ViewRetained.java:27: error: unexpected end tag: </p> [ERROR] * will be propagated across navigations to the same view ID.</p> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/bean/WindowScopeBeanLocator.java:36: error: @param name not found [ERROR] * @param session servlet session [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:28: warning: no @ return [ERROR] public BrowserType browser(); [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:37: warning: no @ return [ERROR] public String name(); [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:47: warning: no @ return [ERROR] public String library() default ""; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEBrowserDependency.java:60: warning: no @ return [ERROR] public String target() default ""; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:44: warning: no @ return [ERROR] public BrowserType browser() default BrowserType.ALL; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:34: warning: no @ return [ERROR] public ICEBrowserDependency[] browserOverride() default {}; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:63: warning: no @ return [ERROR] public String library() default ""; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:53: warning: no @ return [ERROR] public String name() default ""; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/resources/ICEResourceDependency.java:76: warning: no @ return [ERROR] public String target() default ""; [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/ClientDescriptor.java:312: error: bad use of '>' [ERROR] * ICE-10828 note that IF4 does not support iOS4, so just assume if iOS it is now > iOS4 and has [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/ClientDescriptor.java:314: warning: no description for @ return [ERROR] * @ return [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:388: error: malformed HTML [ERROR] * and works together with the 'ariaEnabled' attribute of the ICEfaces configuration tag <ice:config> so that ARIA support [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:388: error: bad use of '>' [ERROR] * and works together with the 'ariaEnabled' attribute of the ICEfaces configuration tag <ice:config> so that ARIA support [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:417: error: malformed HTML [ERROR] * together with the render attribute of the ICEfaces configuration tag <ice:config> so that DOM updates can be turned on [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:417: error: bad use of '>' [ERROR] * together with the render attribute of the ICEfaces configuration tag <ice:config> so that DOM updates can be turned on [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:430: error: malformed HTML [ERROR] * together with the compressIDs attribute of the ICEfaces configuration tag <ice:config> so that ID [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:430: error: bad use of '>' [ERROR] * together with the compressIDs attribute of the ICEfaces configuration tag <ice:config> so that ID [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:448: error: self-closing element not allowed [ERROR] * <p/> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:465: warning: no description for @param [ERROR] * @param value [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:498: error: self-closing element not allowed [ERROR] * <p/> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:555: error: self-closing element not allowed [ERROR] * <p/> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:557: error: malformed HTML [ERROR] * configuration tag <ice:config> so that ICEpush can be set to activate lazily on a per-page basis. [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:557: error: bad use of '>' [ERROR] * configuration tag <ice:config> so that ICEpush can be set to activate lazily on a per-page basis. [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:619: error: self-closing element not allowed [ERROR] * <p/> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:634: error: self-closing element not allowed [ERROR] * <p/> [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/EnvUtils.java:1039: warning: no description for @param [ERROR] * @param value [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:187: error: @param name not found [ERROR] * @param userAgent [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:187: warning: no description for @param [ERROR] * @param userAgent [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:203: error: @param name not found [ERROR] * @param userAgent [ERROR] ^ [ERROR] /Users/Ken/Code/svn/icefaces-4.2.0.BETA-TAG/icefaces/core/src/main/java/org/icefaces/util/UserAgentInfo.java:203: warning: no description for @param [ERROR] * @param userAgent [ERROR] ^ [ERROR] [ERROR] Command line was: /Library/Java/JavaVirtualMachines/jdk1.8.0_92.jdk/Contents/Home/bin/javadoc @options @packages [ERROR]
        Hide
        Ken Fyten added a comment -

        Corrected misc. JavaDoc errors.

        Show
        Ken Fyten added a comment - Corrected misc. JavaDoc errors.

          People

          • Assignee:
            Ken Fyten
            Reporter:
            Ken Fyten
          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: