Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.5
    • Component/s: build
    • Labels:

      Description

      Creating this jira to find and fix the javadoc warnings and errors.

      With JDK 8, we are unable to get Javadoc unless your tool meets the standards of doclint.

      Some of its rules are:


      no self-closed HTML tags, such as <br /> or <a id="x" />
      no unclosed HTML tags, such as <ul> without matching </ul>
      no invalid HTML end tags, such as </br>
      no invalid HTML attributes, based on doclint's interpretation of W3C HTML 4.01
      no duplicate HTML id attribute
      no empty HTML href attribute
      no incorrectly nested headers, such as class documentation must have <h3>, not <h4>
      no invalid HTML tags, such as List<String> (where you forgot to escape using &lt;)
      no broken @link references
      no broken @param references, they must match the actual parameter name
      no broken @throws references, the first word must be a class name
      

      We don't get any output if it breaks any of the above rule. It throws errors.

      We can turn off doclint by configuring the following propery for javadoc plugin

      <additionalparam>-Xdoclint:none</additionalparam>

      1. rb39419.patch
        9 kB
        Amareshwari Sriramadasu

        Issue Links

          Activity

          Hide
          gliptak Gabor Liptak added a comment -
          Show
          gliptak Gabor Liptak added a comment - Working this at https://reviews.apache.org/r/39419/
          Hide
          raju.bairishetti Raju Bairishetti added a comment -

          Gabor Liptak Thanks for working on this issue. Assigning this issue to you.

          Show
          raju.bairishetti Raju Bairishetti added a comment - Gabor Liptak Thanks for working on this issue. Assigning this issue to you.
          Hide
          amareshwari Amareshwari Sriramadasu added a comment -

          Taking patch from review board and attaching

          Show
          amareshwari Amareshwari Sriramadasu added a comment - Taking patch from review board and attaching
          Hide
          hadoopqa Hadoop QA added a comment -

          Applied patch: rb39419.patch and ran command: mvn clean install -fae. Result: Success. Build Job: https://builds.apache.org/job/PreCommit-Lens-Build/169/

          Show
          hadoopqa Hadoop QA added a comment - Applied patch: rb39419.patch and ran command: mvn clean install -fae. Result: Success. Build Job: https://builds.apache.org/job/PreCommit-Lens-Build/169/
          Hide
          prongs Rajat Khandelwal added a comment -

          Committed. Thanks Gabor Liptak

          Show
          prongs Rajat Khandelwal added a comment - Committed. Thanks Gabor Liptak
          Hide
          hudson Hudson added a comment -

          UNSTABLE: Integrated in Lens-Commit #1128 (See https://builds.apache.org/job/Lens-Commit/1128/)
          LENS-824 Fix all javadoc warnings/errors (rajatgupta59: rev 10dcebb9247f605769dfd90e25be82aff3f79dbc)

          • lens-server/src/main/java/org/apache/lens/server/scheduler/QuerySchedulerServiceImpl.java
          • lens-server/src/main/java/org/apache/lens/server/quota/QuotaServiceImpl.java
          • lens-api/src/main/java/org/apache/lens/api/result/PrettyPrintable.java
          • lens-api/src/main/java/org/apache/lens/api/query/save/ParameterCollectionType.java
          • lens-server/src/main/java/org/apache/lens/server/session/HiveSessionService.java
          • lens-server/src/main/java/org/apache/lens/server/query/save/SavedQueryDao.java
          • lens-server/src/main/java/org/apache/lens/server/query/QueryExecutionServiceImpl.java
          • pom.xml
          • lens-server/src/main/java/org/apache/lens/server/metastore/CubeMetastoreServiceImpl.java
          • lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java
          • lens-api/src/main/java/org/apache/lens/api/util/PathValidator.java
          Show
          hudson Hudson added a comment - UNSTABLE: Integrated in Lens-Commit #1128 (See https://builds.apache.org/job/Lens-Commit/1128/ ) LENS-824 Fix all javadoc warnings/errors (rajatgupta59: rev 10dcebb9247f605769dfd90e25be82aff3f79dbc) lens-server/src/main/java/org/apache/lens/server/scheduler/QuerySchedulerServiceImpl.java lens-server/src/main/java/org/apache/lens/server/quota/QuotaServiceImpl.java lens-api/src/main/java/org/apache/lens/api/result/PrettyPrintable.java lens-api/src/main/java/org/apache/lens/api/query/save/ParameterCollectionType.java lens-server/src/main/java/org/apache/lens/server/session/HiveSessionService.java lens-server/src/main/java/org/apache/lens/server/query/save/SavedQueryDao.java lens-server/src/main/java/org/apache/lens/server/query/QueryExecutionServiceImpl.java pom.xml lens-server/src/main/java/org/apache/lens/server/metastore/CubeMetastoreServiceImpl.java lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java lens-api/src/main/java/org/apache/lens/api/util/PathValidator.java
          Hide
          hudson Hudson added a comment -

          SUCCESS: Integrated in Lens-Commit-Java8 #39 (See https://builds.apache.org/job/Lens-Commit-Java8/39/)
          LENS-824 Fix all javadoc warnings/errors (rajatgupta59: rev 10dcebb9247f605769dfd90e25be82aff3f79dbc)

          • lens-server/src/main/java/org/apache/lens/server/metastore/CubeMetastoreServiceImpl.java
          • lens-api/src/main/java/org/apache/lens/api/result/PrettyPrintable.java
          • lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java
          • lens-api/src/main/java/org/apache/lens/api/query/save/ParameterCollectionType.java
          • pom.xml
          • lens-server/src/main/java/org/apache/lens/server/query/QueryExecutionServiceImpl.java
          • lens-server/src/main/java/org/apache/lens/server/query/save/SavedQueryDao.java
          • lens-server/src/main/java/org/apache/lens/server/session/HiveSessionService.java
          • lens-server/src/main/java/org/apache/lens/server/scheduler/QuerySchedulerServiceImpl.java
          • lens-api/src/main/java/org/apache/lens/api/util/PathValidator.java
          • lens-server/src/main/java/org/apache/lens/server/quota/QuotaServiceImpl.java
          Show
          hudson Hudson added a comment - SUCCESS: Integrated in Lens-Commit-Java8 #39 (See https://builds.apache.org/job/Lens-Commit-Java8/39/ ) LENS-824 Fix all javadoc warnings/errors (rajatgupta59: rev 10dcebb9247f605769dfd90e25be82aff3f79dbc) lens-server/src/main/java/org/apache/lens/server/metastore/CubeMetastoreServiceImpl.java lens-api/src/main/java/org/apache/lens/api/result/PrettyPrintable.java lens-cli/src/main/java/org/apache/lens/cli/commands/LensQueryCommands.java lens-api/src/main/java/org/apache/lens/api/query/save/ParameterCollectionType.java pom.xml lens-server/src/main/java/org/apache/lens/server/query/QueryExecutionServiceImpl.java lens-server/src/main/java/org/apache/lens/server/query/save/SavedQueryDao.java lens-server/src/main/java/org/apache/lens/server/session/HiveSessionService.java lens-server/src/main/java/org/apache/lens/server/scheduler/QuerySchedulerServiceImpl.java lens-api/src/main/java/org/apache/lens/api/util/PathValidator.java lens-server/src/main/java/org/apache/lens/server/quota/QuotaServiceImpl.java

            People

            • Assignee:
              gliptak Gabor Liptak
              Reporter:
              raju.bairishetti Raju Bairishetti
            • Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development