• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/InheritDocTaglet.java@93012e2a5d1d (annotated)

src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/InheritDocTaglet.java

Sat, 07 Nov 2020 10:30:02 +0800

author

aoqi

date

Sat, 07 Nov 2020 10:30:02 +0800

changeset 3938

93012e2a5d1d

parent 2525

2eb010b6cb22

permissions

-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.internal.toolkit.taglets;
aoqi@0	27
aoqi@0	28	import com.sun.javadoc.*;
aoqi@0	29	import com.sun.tools.doclets.internal.toolkit.Configuration;
aoqi@0	30	import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0	31	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	32
aoqi@0	33	/**
aoqi@0	34	* An inline Taglet representing the <b>inheritDoc</b> tag. This tag should only
aoqi@0	35	* be used with a method. It is used to inherit documentation from overriden
aoqi@0	36	* and implemented methods.
aoqi@0	37	*
aoqi@0	38	* <p><b>This is NOT part of any supported API.
aoqi@0	39	* If you write code that depends on this, you do so at your own risk.
aoqi@0	40	* This code and its internal interfaces are subject to change or
aoqi@0	41	* deletion without notice.</b>
aoqi@0	42	*
aoqi@0	43	* @author Jamie Ho
aoqi@0	44	* @since 1.4
aoqi@0	45	*/
aoqi@0	46
aoqi@0	47	public class InheritDocTaglet extends BaseInlineTaglet {
aoqi@0	48
aoqi@0	49	/**
aoqi@0	50	* The inline tag that would appear in the documentation if
aoqi@0	51	* the writer wanted documentation to be inherited.
aoqi@0	52	*/
aoqi@0	53	public static final String INHERIT_DOC_INLINE_TAG = "{@inheritDoc}";
aoqi@0	54
aoqi@0	55	/**
aoqi@0	56	* Construct a new InheritDocTaglet.
aoqi@0	57	*/
aoqi@0	58	public InheritDocTaglet () {
aoqi@0	59	name = "inheritDoc";
aoqi@0	60	}
aoqi@0	61
aoqi@0	62	/**
aoqi@0	63	* Will return false because this inline tag may
aoqi@0	64	* not appear in Fields.
aoqi@0	65	* @return false
aoqi@0	66	*/
aoqi@0	67	public boolean inField() {
aoqi@0	68	return false;
aoqi@0	69	}
aoqi@0	70
aoqi@0	71	/**
aoqi@0	72	* Will return false because this inline tag may
aoqi@0	73	* not appear in Constructors.
aoqi@0	74	* @return false
aoqi@0	75	*/
aoqi@0	76	public boolean inConstructor() {
aoqi@0	77	return false;
aoqi@0	78	}
aoqi@0	79
aoqi@0	80	/**
aoqi@0	81	* Will return false because this inline tag may
aoqi@0	82	* not appear in Overview.
aoqi@0	83	* @return false
aoqi@0	84	*/
aoqi@0	85	public boolean inOverview() {
aoqi@0	86	return false;
aoqi@0	87	}
aoqi@0	88
aoqi@0	89	/**
aoqi@0	90	* Will return false because this inline tag may
aoqi@0	91	* not appear in Packages.
aoqi@0	92	* @return false
aoqi@0	93	*/
aoqi@0	94	public boolean inPackage() {
aoqi@0	95	return false;
aoqi@0	96	}
aoqi@0	97
aoqi@0	98	/**
aoqi@0	99	* Will return true because this inline tag may
aoqi@0	100	* appear in Type (Class).
aoqi@0	101	* @return true
aoqi@0	102	*/
aoqi@0	103	public boolean inType() {
aoqi@0	104	return true;
aoqi@0	105	}
aoqi@0	106
aoqi@0	107	/**
aoqi@0	108	* Given a <code>MethodDoc</code> item, a <code>Tag</code> in the
aoqi@0	109	* <code>MethodDoc</code> item and a String, replace all occurrences
aoqi@0	110	* of @inheritDoc with documentation from it's superclass or superinterface.
aoqi@0	111	*
aoqi@0	112	* @param writer the writer that is writing the output.
aoqi@0	113	* @param ped the {@link ProgramElementDoc} that we are documenting.
aoqi@0	114	* @param holderTag the tag that holds the inheritDoc tag or null for type
aoqi@0	115	* (class) docs.
aoqi@0	116	* @param isFirstSentence true if we only want to inherit the first sentence.
aoqi@0	117	*/
aoqi@0	118	private Content retrieveInheritedDocumentation(TagletWriter writer,
aoqi@0	119	ProgramElementDoc ped, Tag holderTag, boolean isFirstSentence) {
aoqi@0	120	Content replacement = writer.getOutputInstance();
aoqi@0	121
aoqi@0	122	Configuration configuration = writer.configuration();
aoqi@0	123	Taglet inheritableTaglet = holderTag == null ?
aoqi@0	124	null : configuration.tagletManager.getTaglet(holderTag.name());
aoqi@0	125	if (inheritableTaglet != null &&
aoqi@0	126	!(inheritableTaglet instanceof InheritableTaglet)) {
aoqi@0	127	String message = ped.name() +
aoqi@0	128	((ped instanceof ExecutableMemberDoc)
aoqi@0	129	? ((ExecutableMemberDoc)ped).flatSignature()
aoqi@0	130	: "");
aoqi@0	131	//This tag does not support inheritence.
aoqi@0	132	configuration.message.warning(ped.position(),
aoqi@0	133	"doclet.noInheritedDoc", message);
aoqi@0	134	}
aoqi@0	135	DocFinder.Output inheritedDoc =
aoqi@0	136	DocFinder.search(new DocFinder.Input(ped,
aoqi@0	137	(InheritableTaglet) inheritableTaglet, holderTag,
aoqi@0	138	isFirstSentence, true));
aoqi@0	139	if (inheritedDoc.isValidInheritDocTag) {
aoqi@0	140	if (inheritedDoc.inlineTags.length > 0) {
aoqi@0	141	replacement = writer.commentTagsToOutput(inheritedDoc.holderTag,
aoqi@0	142	inheritedDoc.holder, inheritedDoc.inlineTags, isFirstSentence);
aoqi@0	143	}
aoqi@0	144	} else {
aoqi@0	145	String message = ped.name() +
aoqi@0	146	((ped instanceof ExecutableMemberDoc)
aoqi@0	147	? ((ExecutableMemberDoc)ped).flatSignature()
aoqi@0	148	: "");
aoqi@0	149	configuration.message.warning(ped.position(),
aoqi@0	150	"doclet.noInheritedDoc", message);
aoqi@0	151	}
aoqi@0	152	return replacement;
aoqi@0	153	}
aoqi@0	154
aoqi@0	155	/**
aoqi@0	156	* Given the <code>Tag</code> representation of this custom
aoqi@0	157	* tag, return its string representation, which is output
aoqi@0	158	* to the generated page.
aoqi@0	159	* @param tag the <code>Tag</code> representation of this custom tag.
aoqi@0	160	* @param tagletWriter the taglet writer for output.
aoqi@0	161	* @return the Content representation of this <code>Tag</code>.
aoqi@0	162	*/
aoqi@0	163	public Content getTagletOutput(Tag tag, TagletWriter tagletWriter) {
aoqi@0	164	if (! (tag.holder() instanceof ProgramElementDoc)) {
aoqi@0	165	return tagletWriter.getOutputInstance();
aoqi@0	166	}
aoqi@0	167	return tag.name().equals("@inheritDoc") ?
aoqi@0	168	retrieveInheritedDocumentation(tagletWriter, (ProgramElementDoc) tag.holder(), null, tagletWriter.isFirstSentence) :
aoqi@0	169	retrieveInheritedDocumentation(tagletWriter, (ProgramElementDoc) tag.holder(), tag, tagletWriter.isFirstSentence);
aoqi@0	170	}
aoqi@0	171	}