From commits-return-126756-archive-asf-public=cust-asf.ponee.io@ignite.apache.org Thu Jul 9 04:58:14 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 384ED180621 for ; Thu, 9 Jul 2020 06:58:14 +0200 (CEST) Received: (qmail 49022 invoked by uid 500); 9 Jul 2020 04:58:13 -0000 Mailing-List: contact commits-help@ignite.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ignite.apache.org Delivered-To: mailing list commits@ignite.apache.org Received: (qmail 49009 invoked by uid 99); 9 Jul 2020 04:58:13 -0000 Received: from ec2-52-202-80-70.compute-1.amazonaws.com (HELO gitbox.apache.org) (52.202.80.70) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 09 Jul 2020 04:58:13 +0000 Received: by gitbox.apache.org (ASF Mail Server at gitbox.apache.org, from userid 33) id 8333C8BF1E; Thu, 9 Jul 2020 04:58:12 +0000 (UTC) Date: Thu, 09 Jul 2020 04:58:11 +0000 To: "commits@ignite.apache.org" Subject: [ignite] branch ignite-2.9 updated: IGNITE-11393 Fix javadoc maven build for java9+ - Fixes #7983. MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Message-ID: <159427069104.19475.2540022057935754044@gitbox.apache.org> From: alexpl@apache.org X-Git-Host: gitbox.apache.org X-Git-Repo: ignite X-Git-Refname: refs/heads/ignite-2.9 X-Git-Reftype: branch X-Git-Oldrev: 5261a9289884ed90ad0734f962dbd97d52488f0b X-Git-Newrev: e4bfec1870cbcadf5a075d06f95ba762a9ba91b6 X-Git-Rev: e4bfec1870cbcadf5a075d06f95ba762a9ba91b6 X-Git-NotificationType: ref_changed_plus_diff X-Git-Multimail-Version: 1.5.dev Auto-Submitted: auto-generated This is an automated email from the ASF dual-hosted git repository. alexpl pushed a commit to branch ignite-2.9 in repository https://gitbox.apache.org/repos/asf/ignite.git The following commit(s) were added to refs/heads/ignite-2.9 by this push: new e4bfec1 IGNITE-11393 Fix javadoc maven build for java9+ - Fixes #7983. e4bfec1 is described below commit e4bfec1870cbcadf5a075d06f95ba762a9ba91b6 Author: Aleksey Plekhanov AuthorDate: Thu Jul 9 09:29:40 2020 +0500 IGNITE-11393 Fix javadoc maven build for java9+ - Fixes #7983. Signed-off-by: Aleksey Plekhanov (cherry picked from commit 3006dd80d80e6996fa8cfeff708d4f8a71cefac6) --- .../tools/ant/beautifier/GridJavadocAntTask.java | 5 +- .../ignite/tools/javadoc/IgniteLinkTaglet.java | 107 ++++++++++----------- parent/pom.xml | 16 ++- pom.xml | 21 ++++ 4 files changed, 87 insertions(+), 62 deletions(-) diff --git a/modules/tools/src/main/java/org/apache/ignite/tools/ant/beautifier/GridJavadocAntTask.java b/modules/tools/src/main/java/org/apache/ignite/tools/ant/beautifier/GridJavadocAntTask.java index 4f49eb3..67cfb65 100644 --- a/modules/tools/src/main/java/org/apache/ignite/tools/ant/beautifier/GridJavadocAntTask.java +++ b/modules/tools/src/main/java/org/apache/ignite/tools/ant/beautifier/GridJavadocAntTask.java @@ -166,6 +166,7 @@ public class GridJavadocAntTask extends MatchingTask { // Parse HTML. Jerry doc = Jerry.jerry(fileContent); + // TODO https://issues.apache.org/jira/browse/IGNITE-13202 Check also index.html file. if (file.endsWith("overview-summary.html")) { // Try to find Other Packages section. Jerry otherPackages = @@ -181,7 +182,7 @@ public class GridJavadocAntTask extends MatchingTask { } else if (!isViewHtml(file)) { // Try to find a class description block. - Jerry descBlock = doc.find("div.contentContainer div.description ul.blockList li.blockList div.block"); + Jerry descBlock = doc.find("div.contentContainer .description"); if (descBlock.size() == 0) throw new IllegalArgumentException("Class doesn't have description in file: " + file); @@ -372,7 +373,7 @@ public class GridJavadocAntTask extends MatchingTask { private boolean isViewHtml(String fileName) { String baseName = new File(fileName).getName(); - return "index.html".equals(baseName) || baseName.contains("-"); + return "index.html".equals(baseName) || baseName.contains("-") || "allclasses.html".equals(baseName); } /** diff --git a/modules/tools/src/main/java11/org/apache/ignite/tools/javadoc/IgniteLinkTaglet.java b/modules/tools/src/main/java11/org/apache/ignite/tools/javadoc/IgniteLinkTaglet.java index 075fea6..78663c6 100644 --- a/modules/tools/src/main/java11/org/apache/ignite/tools/javadoc/IgniteLinkTaglet.java +++ b/modules/tools/src/main/java11/org/apache/ignite/tools/javadoc/IgniteLinkTaglet.java @@ -19,13 +19,14 @@ package org.apache.ignite.tools.javadoc; import java.io.File; import java.util.HashSet; -import java.util.Iterator; import java.util.List; -import java.util.Map; import java.util.Set; import javax.lang.model.element.Element; -import com.sun.javadoc.Tag; import com.sun.source.doctree.DocTree; +import com.sun.source.doctree.UnknownInlineTagTree; +import com.sun.source.util.SimpleDocTreeVisitor; +import jdk.javadoc.doclet.Doclet; +import jdk.javadoc.doclet.DocletEnvironment; import jdk.javadoc.doclet.Taglet; /** @@ -37,6 +38,14 @@ public class IgniteLinkTaglet implements Taglet { /** */ private static final String NAME = "ignitelink"; + /** */ + private DocletEnvironment env; + + /** {@inheritDoc} */ + @Override public void init(DocletEnvironment env, Doclet doclet) { + this.env = env; + } + /** * Return the name of this custom tag. */ @@ -44,18 +53,7 @@ public class IgniteLinkTaglet implements Taglet { return NAME; } - @Override public String toString(List tags, Element element) { - StringBuilder sb = new StringBuilder(); - - for (Iterator iter = tags.iterator(); iter.hasNext(); ) { - DocTree next = iter.next(); - - sb.append(""); //todo IGNITE-11393 Implement toString for Java 9+ - } - - return sb.toString(); - } - + /** {@inheritDoc} */ @Override public Set getAllowedLocations() { return new HashSet<>(); } @@ -70,64 +68,59 @@ public class IgniteLinkTaglet implements Taglet { } /** - * Register this Taglet. - * - * @param tagletMap the map to register this tag to. - */ - public static void register(Map tagletMap) { - IgniteLinkTaglet tag = new IgniteLinkTaglet(); - - Taglet t = tagletMap.get(tag.getName()); - - if (t != null) - tagletMap.remove(tag.getName()); - - tagletMap.put(tag.getName(), tag); - } - - /** - * Given the Tag representation of this custom tag, return its string representation. + * Given the DocTree representation of this custom tag, return its string representation. *

* Input: org.apache.ignite.grid.spi.indexing.h2.GridH2IndexingSpi#setIndexCustomFunctionClasses(Class[]) *

- * Output: - * GridH2IndexingSpi.setIndexCustomFunctionClasses(java.lang.Class[]) + * Output: <a href="../../../../../org/apache/ignite/grid/spi/indexing/h2/GridH2IndexingSpi.html# + * setIndexCustomFunctionClasses(java.lang.Class...)"> + * <code>GridH2IndexingSpi.setIndexCustomFunctionClasses(java.lang.Class[])</code></a> * - * @param tag Tag representation of this custom tag. + * @param tags DocTree representation of this custom tag. + * @param element The element to which the enclosing comment belongs. */ - public String toString(Tag tag) { - if (tag.text() == null || tag.text().isEmpty()) - return ""; + @Override public String toString(List tags, Element element) { + for (DocTree tag : tags) { + String text = new SimpleDocTreeVisitor() { + @Override public String visitUnknownInlineTag(UnknownInlineTagTree node, Void param) { + return node.getContent().toString(); + } + }.visit(tag, null); - File f = tag.position().file(); + if (text == null || text.isEmpty()) + return ""; - String curClass = f == null ? "" : f.getAbsolutePath().replace(File.separator, "."); + File f = new File(env.getDocTrees().getPath(element).getCompilationUnit().getSourceFile().toUri()); - String packPref = "src.main.java."; + String curCls = f == null ? "" : f.getAbsolutePath().replace(File.separator, "."); - int idx = curClass.indexOf(packPref); + String packPref = "src.main.java."; - StringBuilder path = new StringBuilder(); + int idx = curCls.indexOf(packPref); - if (idx != -1) { - curClass = curClass.substring(idx + packPref.length()); + StringBuilder path = new StringBuilder(); - for (int i = 0, n = curClass.split("\\.").length - 2; i < n; i++) - path.append("../"); - } + if (idx != -1) { + curCls = curCls.substring(idx + packPref.length()); - String[] tokens = tag.text().split("#"); + for (int i = 0, n = curCls.split("\\.").length - 2; i < n; i++) + path.append("../"); + } - int lastIdx = tokens[0].lastIndexOf('.'); + String[] tokens = text.split("#"); - String simpleClsName = lastIdx != -1 && lastIdx + 1 < tokens[0].length() ? - tokens[0].substring(lastIdx + 1) : tokens[0]; + int lastIdx = tokens[0].lastIndexOf('.'); - String fullyQClsName = tokens[0].replace(".", "/"); + String simpleClsName = lastIdx != -1 && lastIdx + 1 < tokens[0].length() ? + tokens[0].substring(lastIdx + 1) : tokens[0]; + + String fullyQClsName = tokens[0].replace(".", "/"); + + return " 1 ? ("#" + tokens[1].replace("[]", "...")) : "") + + "\">" + simpleClsName + (tokens.length > 1 ? ("." + tokens[1]) : "") + ""; + } - return " 1 ? ("#" + tokens[1].replace("[]", "...")) : "") + - "\">" + simpleClsName + (tokens.length > 1 ? ("." + tokens[1]) : "") + ""; + return ""; } } diff --git a/parent/pom.xml b/parent/pom.xml index aad7b6c..0e3cab9 100644 --- a/parent/pom.xml +++ b/parent/pom.xml @@ -146,7 +146,7 @@ 2.4.4 - 2.10.4 + 3.2.0 * @@ -289,7 +289,7 @@ true false false - ${javadoc.opts} + ${javadoc.opts} Common Grid APIs @@ -333,7 +333,7 @@ Streaming APIs - org.apache.ignite.streamer*::org.apache.ignite.stream* + org.apache.ignite.streamer*:org.apache.ignite.stream* Security APIs @@ -1063,6 +1063,16 @@ --add-exports=java.base/jdk.internal.misc=ALL-UNNAMED --add-exports=java.base/sun.nio.ch=ALL-UNNAMED --add-exports=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED --add-exports=jdk.internal.jvmstat/sun.jvmstat.monitor=ALL-UNNAMED --add-exports=java.base/sun.reflect.generics.reflectiveObjects=ALL-UNNAMED --illegal-access=permit + + + org.apache.maven.plugins + maven-javadoc-plugin + + + ${javadoc.opts} --add-exports=java.base/sun.nio.ch=ALL-UNNAMED --add-exports=java.management/com.sun.jmx.mbeanserver=ALL-UNNAMED + false + + diff --git a/pom.xml b/pom.xml index bd44b9d..ea99288 100644 --- a/pom.xml +++ b/pom.xml @@ -205,6 +205,27 @@ validate + + + + org.springframework.data + spring-data-commons + ${spring.data-2.0.version} + + + + + org.apache.ignite + ignite-tools + ${project.version} + ${basedir}/target/javadoc core org.apache.ignite -exclude org.apache.ignite.codegen:org.apache.ignite.examples:org.apache.ignite.internal:org.apache.ignite.schema:org.apache.ignite.tests:org.apache.ignite.tools:org.apache.ignite.util:org.apache.ignite.spi.discovery.tcp.messages:org.apache.ignite.spi.discovery.tcp.internal:org.apache.ignite.spi.communication.tcp.internal:org.apache.ignite.spi.discovery.zk.internal:org.apache.ignite.spi.deployment.uri.scanners:org.apache. [...]