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

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

src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/BaseExecutableMemberTaglet.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, 2012, 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	/**
aoqi@0	29	* An abstract class for that implements the {@link Taglet} interface
aoqi@0	30	* for tags in <code>ExecutableMembers</code>.
aoqi@0	31	*
aoqi@0	32	* <p><b>This is NOT part of any supported API.
aoqi@0	33	* If you write code that depends on this, you do so at your own risk.
aoqi@0	34	* This code and its internal interfaces are subject to change or
aoqi@0	35	* deletion without notice.</b>
aoqi@0	36	*
aoqi@0	37	* @author Jamie Ho
aoqi@0	38	* @since 1.4
aoqi@0	39	*/
aoqi@0	40	public abstract class BaseExecutableMemberTaglet extends BaseTaglet {
aoqi@0	41
aoqi@0	42	/**
aoqi@0	43	* Return true if this <code>Taglet</code>
aoqi@0	44	* is used in field documentation.
aoqi@0	45	* @return true if this <code>Taglet</code>
aoqi@0	46	* is used in field documentation and false
aoqi@0	47	* otherwise.
aoqi@0	48	*/
aoqi@0	49	public boolean inField() {
aoqi@0	50	return false;
aoqi@0	51	}
aoqi@0	52
aoqi@0	53	/**
aoqi@0	54	* Return true if this <code>Taglet</code>
aoqi@0	55	* is used in overview documentation.
aoqi@0	56	* @return true if this <code>Taglet</code>
aoqi@0	57	* is used in overview documentation and false
aoqi@0	58	* otherwise.
aoqi@0	59	*/
aoqi@0	60	public boolean inOverview() {
aoqi@0	61	return false;
aoqi@0	62	}
aoqi@0	63
aoqi@0	64	/**
aoqi@0	65	* Return true if this <code>Taglet</code>
aoqi@0	66	* is used in package documentation.
aoqi@0	67	* @return true if this <code>Taglet</code>
aoqi@0	68	* is used in package documentation and false
aoqi@0	69	* otherwise.
aoqi@0	70	*/
aoqi@0	71	public boolean inPackage() {
aoqi@0	72	return false;
aoqi@0	73	}
aoqi@0	74
aoqi@0	75	/**
aoqi@0	76	* Return true if this <code>Taglet</code>
aoqi@0	77	* is used in type documentation (classes or interfaces).
aoqi@0	78	* @return true if this <code>Taglet</code>
aoqi@0	79	* is used in type documentation and false
aoqi@0	80	* otherwise.
aoqi@0	81	*/
aoqi@0	82	public boolean inType() {
aoqi@0	83	return false;
aoqi@0	84	}
aoqi@0	85
aoqi@0	86	/**
aoqi@0	87	* Return true if this <code>Taglet</code>
aoqi@0	88	* is an inline tag.
aoqi@0	89	* @return true if this <code>Taglet</code>
aoqi@0	90	* is an inline tag and false otherwise.
aoqi@0	91	*/
aoqi@0	92	public boolean isInlineTag() {
aoqi@0	93	return false;
aoqi@0	94	}
aoqi@0	95	}