[
https://issues.apache.org/jira/browse/TINKERPOP-2991?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yang Xia updated TINKERPOP-2991:
--------------------------------
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:
{code:java}
https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate(java.lang.String){code}
JDK 8 format:
{code:java}
https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate-java.lang.String-{code}
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+.
was:
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:
{code:java}
https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate(java.lang.String){code}
[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:
{code:java}
https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate-java.lang.String-{code}
[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+.
> Reformat Javadoc link in reference docs
> ---------------------------------------
>
> Key: TINKERPOP-2991
> URL: https://issues.apache.org/jira/browse/TINKERPOP-2991
> Project: TinkerPop
> Issue Type: Task
> Components: documentation
> Affects Versions: 3.7.0, 3.6.2, 3.5.5
> Reporter: Yang Xia
> Priority: Blocker
>
> 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:
> {code:java}
> https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate(java.lang.String){code}
> JDK 8 format:
> {code:java}
> https://tinkerpop.apache.org/javadocs/3.7.0/core/org/apache/tinkerpop/gremlin/process/traversal/dsl/graph/GraphTraversal.html#aggregate-java.lang.String-{code}
>
> 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+.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
