Derby
  1. Derby
  2. DERBY-5247

Warnings regarding XPath displayed when generating JavaDoc

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.8.1.2, 10.9.1.0
    • Fix Version/s: 10.8.2.2, 10.9.1.0
    • Component/s: Build tools, Javadoc
    • Labels:
      None

      Description

      When generating JavaDocs for Derby. the following warnings are displayed:
      [javadoc] Constructing Javadoc information...
      [javadoc] /home/kw160128/derby/commits/10.8/java/engine/org/apache/derby/iapi/types/SqlXmlUtil.java:51: package org.w3c.dom.xpath does not exist
      [javadoc] import org.w3c.dom.xpath.XPathEvaluator;
      [javadoc] ^
      [javadoc] /home/kw160128/derby/commits/10.8/java/engine/org/apache/derby/iapi/types/SqlXmlUtil.java:52: package org.w3c.dom.xpath does not exist
      [javadoc] import org.w3c.dom.xpath.XPathExpression;
      [javadoc] ^
      [javadoc] /home/kw160128/derby/commits/10.8/java/engine/org/apache/derby/iapi/types/SqlXmlUtil.java:53: package org.w3c.dom.xpath does not exist
      [javadoc] import org.w3c.dom.xpath.XPathResult;
      [javadoc] ^
      [javadoc] /home/kw160128/derby/commits/10.8/java/engine/org/apache/derby/iapi/types/SqlXmlUtil.java:128: cannot find symbol
      [javadoc] symbol : class XPathExpression
      [javadoc] location: class org.apache.derby.iapi.types.SqlXmlUtil
      [javadoc] private XPathExpression query;

      1. derby-5247-1a-xpath_javadoc.diff
        0.4 kB
        Kristian Waagan
      2. derby-5247-1b-xpath_javadoc.diff
        3 kB
        Kristian Waagan

        Activity

        Hide
        Kristian Waagan added a comment -

        Adding xml-apis.jar to the classpath when generating the JavaDocs fixes the problem.

        Attaching patch 1a, which adds xml-apis.jar to the classpath via jars.extras in extrapath.properties. Derby builds fine with this change, not sure what more to do wrt testing.

        Patch ready for review.

        Show
        Kristian Waagan added a comment - Adding xml-apis.jar to the classpath when generating the JavaDocs fixes the problem. Attaching patch 1a, which adds xml-apis.jar to the classpath via jars.extras in extrapath.properties. Derby builds fine with this change, not sure what more to do wrt testing. Patch ready for review.
        Hide
        Knut Anders Hatlen added a comment -

        Looks fine to me. Perhaps it would be better to add $

        {xmlApis}

        directly to the classpath in the derbydocs ant target, since the comments say jars.extras should contain jar files required at runtime, and xml-apis.jar is just a compile-time dependency. But it seems like jars.extras is only actually used at compile-time, so it probably doesn't matter much.

        Show
        Knut Anders Hatlen added a comment - Looks fine to me. Perhaps it would be better to add $ {xmlApis} directly to the classpath in the derbydocs ant target, since the comments say jars.extras should contain jar files required at runtime, and xml-apis.jar is just a compile-time dependency. But it seems like jars.extras is only actually used at compile-time, so it probably doesn't matter much.
        Hide
        Kristian Waagan added a comment -

        Thanks for looking at the patch, Knut.

        I saw what you commented on, but didn't plan on doing anything about it at this time. However, I have now applied the following changes:
        — extrapath.properties
        o modified comments
        o renamed jars.extra to jars.javadoc
        o added osgi and xmlApis to the above
        o removed jcc and jcc_l from the above
        o deleted jcc and jcc_l
        — build.xml
        o update JavaDoc tasks to use jars.javadoc
        — java/demo/build.xml
        o removed uses of jcc/jcc_l

        Patch 1b ready for review.

        Show
        Kristian Waagan added a comment - Thanks for looking at the patch, Knut. I saw what you commented on, but didn't plan on doing anything about it at this time. However, I have now applied the following changes: — extrapath.properties o modified comments o renamed jars.extra to jars.javadoc o added osgi and xmlApis to the above o removed jcc and jcc_l from the above o deleted jcc and jcc_l — build.xml o update JavaDoc tasks to use jars.javadoc — java/demo/build.xml o removed uses of jcc/jcc_l Patch 1b ready for review.
        Hide
        Knut Anders Hatlen added a comment -

        Thanks, Kristian. The 1b patch looks like a good cleanup. +1.

        Show
        Knut Anders Hatlen added a comment - Thanks, Kristian. The 1b patch looks like a good cleanup. +1.
        Hide
        Kristian Waagan added a comment -

        Committed patch 1b to trunk with revision 1127825, and back-ported it to 10.8 with revision 1127830.

        Show
        Kristian Waagan added a comment - Committed patch 1b to trunk with revision 1127825, and back-ported it to 10.8 with revision 1127830.
        Hide
        Kristian Waagan added a comment -

        Closing issue.

        Show
        Kristian Waagan added a comment - Closing issue.

          People

          • Assignee:
            Kristian Waagan
            Reporter:
            Kristian Waagan
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development