Uploaded image for project: 'TinkerPop'
  1. TinkerPop
  2. TINKERPOP-2991

Reformat Javadoc link in reference docs

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Closed
    • Blocker
    • Resolution: Fixed
    • 3.7.0, 3.6.2, 3.5.5
    • 3.5.8, 3.6.6, 3.7.1
    • documentation
    • None

    Description

      The links for methods in Javadocs html pages was changed in JDK 11, from dash to brackets for parameter, so any Javadocs built with JDK 11+ conforms to the new format, i.e.:

      JDK 11+ new format:

      https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate(java.lang.String)

      JDK 8 format:

      https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate-java.lang.String-

       

      All of our current docs follow the old JDK 8 format, which meant that links to specific methods are not working. We could mitigate this by requiring docs to be built on JDK 8, or we could update all of the links in the docs and require doc building to be on JDK 11+. 

      Attachments

        Activity

          People

            colegreer Cole Greer
            xiazcy Yang Xia
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: