# HG changeset patch # User jjg # Date 1569439161 -7200 # Node ID ebb1ff3d6707d762b56b67e8238f736bcd0b1058 # Parent d885633d9de4cb751e115b68d98f349df686684e Adding taglet for @preview. diff -r d885633d9de4 -r ebb1ff3d6707 make/Docs.gmk --- a/make/Docs.gmk Tue Sep 24 15:40:26 2019 +0200 +++ b/make/Docs.gmk Wed Sep 25 21:19:21 2019 +0200 @@ -95,6 +95,7 @@ -tag see \ -taglet build.tools.taglet.ExtLink \ -taglet build.tools.taglet.Incubating \ + -taglet build.tools.taglet.Preview \ -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ $(CUSTOM_JAVADOC_TAGS) \ # diff -r d885633d9de4 -r ebb1ff3d6707 make/jdk/src/classes/build/tools/taglet/Preview.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/make/jdk/src/classes/build/tools/taglet/Preview.java Wed Sep 25 21:19:21 2019 +0200 @@ -0,0 +1,70 @@ +/* + * Copyright (c) 2019, 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 javax.lang.model.element.Element; +import com.sun.source.doctree.DocTree; +import com.sun.source.doctree.UnknownBlockTagTree; +import jdk.javadoc.doclet.Taglet; +import static jdk.javadoc.doclet.Taglet.Location.*; + +/** + * An block tag to insert a standard warning about a preview API. + */ +public class Preview implements Taglet { + + /** Returns the set of locations in which a taglet may be used. */ + @Override + public Set getAllowedLocations() { + return EnumSet.of(MODULE, PACKAGE, TYPE, CONSTRUCTOR, METHOD, FIELD); + } + + @Override + public boolean isInlineTag() { + return false; + } + + @Override + public String getName() { + return "preview"; + } + + @Override + public String toString(List tags, Element elem) { + StringBuilder sb = new StringBuilder(); + sb.append("
Preview Feature:\n"); + for (DocTree tag : tags) { + UnknownBlockTagTree ubt = (UnknownBlockTagTree) tag; + sb.append("
Preview: ") + .append(ubt.getContent()); + } + return sb.toString(); + } +} +