ICEpush
  1. ICEpush
  2. PUSH-394

Fix JavaDoc errors reported by Maven

          Details

          • Type: Bug Bug
          • Status: Resolved
          • Priority: Major Major
          • Resolution: Fixed
          • Affects Version/s: EE-4.0.0.GA, 4.1
          • Fix Version/s: EE-4.2.0.GA
          • Component/s: Push Library
          • Labels:
            None
          • Environment:
            ICEpush Core

            Description

            When building ICEpush using Maven the following errors are being reported related to JavaDoc:

            [ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.8.1:jar (attach-javadocs) on project icepush: MavenReportException: Error while creating archive:
            [ERROR] Exit code: 1 - /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:87: warning: no description for @return
            [ERROR] * @return
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:106: warning: no description for @param
            [ERROR] * @param pushId
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:148: warning: no description for @param
            [ERROR] * @param pushId
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:149: warning: no description for @param
            [ERROR] * @param callback
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:56: warning: no description for @param
            [ERROR] * @param contextURI
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:57: error: exception not thrown: org.icepush.client.PushClientException
            [ERROR] * @throws PushClientException
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushClient.java:57: warning: no description for @throws
            [ERROR] * @throws PushClientException
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/PushContext.java:77: warning: no description for @param
            [ERROR] * @param pushConfiguration
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:42: warning: no description for @param
            [ERROR] * @param context
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:43: warning: no description for @param
            [ERROR] * @param quality
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:44: warning: no description for @param
            [ERROR] * @param name
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:45: warning: no description for @param
            [ERROR] * @param extension
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:62: warning: no description for @param
            [ERROR] * @param context
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:63: warning: no description for @param
            [ERROR] * @param name
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:64: warning: no description for @return
            [ERROR] * @return
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:76: warning: no description for @param
            [ERROR] * @param context
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:77: warning: no description for @param
            [ERROR] * @param name
            [ERROR] ^
            [ERROR] /Users/jeroen/Projects/Repositories-READ_ONLY/ossrepo/icefaces4/trunk/icefaces/icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java:78: warning: no description for @return
            [ERROR] * @return
            [ERROR] ^

              Activity

              Ascending order - Click to sort in descending order
              Hide
              Permalink
              Jack Van Ooststroom added a comment -

              Sending icepush/core/src/main/java/org/icepush/PushClient.java
              Sending icepush/core/src/main/java/org/icepush/PushContext.java
              Sending icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java
              Transmitting file data ...
              Committed revision 48579.

              Show
              Jack Van Ooststroom added a comment - Sending icepush/core/src/main/java/org/icepush/PushClient.java Sending icepush/core/src/main/java/org/icepush/PushContext.java Sending icepush/core/src/main/java/org/icepush/util/ExtensionRegistry.java Transmitting file data ... Committed revision 48579.
              Hide
              Permalink
              Jack Van Ooststroom added a comment -

              The JavaDoc errors were related to missing JavaDoc parts of various methods in various classes. All known have been resolved now. Marking this one as FIXED.

              Show
              Jack Van Ooststroom added a comment - The JavaDoc errors were related to missing JavaDoc parts of various methods in various classes. All known have been resolved now. Marking this one as FIXED.

                People

                • Assignee:
                  Jack Van Ooststroom
                  Reporter:
                  Jack Van Ooststroom
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  1 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: