8178725: provide way to link to external documentation

Reviewed-by: erikj, ihse, jjg
2026-02-06 16:38:36 +00:00 · 2017-04-25 07:52:03 -07:00 · 2017-04-25 07:52:03 -07:00 · 021dfd0a66
commit 021dfd0a66
parent b52f472fcf
1 changed files with 109 additions and 0 deletions
--- a/jdk/make/src/classes/build/tools/taglet/ExtLink.java
+++ b/jdk/make/src/classes/build/tools/taglet/ExtLink.java
@ -0,0 +1,109 @@
+/*
+ * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package build.tools.taglet;
+
+import java.util.EnumSet;
+import java.util.List;
+import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import javax.lang.model.element.Element;
+
+import com.sun.source.doctree.DocTree;
+import com.sun.source.doctree.UnknownInlineTagTree;
+import jdk.javadoc.doclet.Taglet;
+
+import static com.sun.source.doctree.DocTree.Kind.*;
+import static jdk.javadoc.doclet.Taglet.Location.*;
+
+/**
+ * An inline tag to conveniently insert an external link.
+ * The tag can be used as follows:
+ * {&#64;extLink name description}, for example
+ * <p>
+ * {@code Please see {@extLink Borealis a spectacular} sight.}
+ * <p>
+ * will produce the following html
+ * <p>
+ * {@code
+ * Please see <a href="https://www.oracle.com/pls/topic/lookup?ctx=javase9&id=Borealis">a spectacular</a> sight.
+ * }
+ */
+public class ExtLink implements Taglet {
+
+    static final String TAG_NAME = "extLink";
+
+    static final String URL = "https://www.oracle.com/pls/topic/lookup?ctx=javase9&id=";
+
+    static final Pattern TAG_PATTERN = Pattern.compile("(\\s*)(?<name>\\w+)(\\s+)(?<desc>.*)");
+
+    /**
+     * Returns the set of locations in which the tag may be used.
+     */
+    @Override
+    public Set<Location> getAllowedLocations() {
+        return EnumSet.allOf(jdk.javadoc.doclet.Taglet.Location.class);
+    }
+
+    @Override
+    public boolean isInlineTag() {
+        return true;
+    }
+
+    @Override
+    public String getName() {
+        return TAG_NAME;
+    }
+
+    @Override
+    public String toString(List<? extends DocTree> tags, Element elem) {
+
+        if (tags.isEmpty())
+            return "";
+
+        DocTree tag = tags.get(0);
+        if (tag.getKind() != UNKNOWN_INLINE_TAG)
+            return "";
+
+        UnknownInlineTagTree uitree = (UnknownInlineTagTree) tag;
+        if (uitree.getContent().isEmpty())
+            return "";
+
+        String tagText = uitree.getContent().get(0).toString();
+        Matcher m = TAG_PATTERN.matcher(tagText);
+        if (!m.find())
+            return "";
+
+        StringBuilder sb = new StringBuilder("<a href=\"");
+        sb.append(URL)
+          .append(m.group("name"))
+          .append("\">")
+          .append(m.group("desc"))
+          .append("</a>");
+
+        return sb.toString();
+    }
+}