BaseExecutableMemberTaglet.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2001, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package jdk.javadoc.internal.doclets.toolkit.taglets;
27
28/**
29 * An abstract class for that implements the {@link Taglet} interface
30 * for tags in <code>ExecutableMembers</code>.
31 *
32 *  <p><b>This is NOT part of any supported API.
33 *  If you write code that depends on this, you do so at your own risk.
34 *  This code and its internal interfaces are subject to change or
35 *  deletion without notice.</b>
36 *
37 * @author Jamie Ho
38 */
39public abstract class BaseExecutableMemberTaglet extends BaseTaglet {
40
41    /**
42     * Return true if this <code>Taglet</code>
43     * is used in field documentation.
44     * @return true if this <code>Taglet</code>
45     * is used in field documentation and false
46     * otherwise.
47     */
48    public boolean inField() {
49        return false;
50    }
51
52    /**
53     * Return true if this <code>Taglet</code>
54     * is used in overview documentation.
55     * @return true if this <code>Taglet</code>
56     * is used in overview documentation and false
57     * otherwise.
58     */
59    public boolean inOverview() {
60        return false;
61    }
62
63    /**
64     * Return true if this <code>Taglet</code>
65     * is used in package documentation.
66     * @return true if this <code>Taglet</code>
67     * is used in package documentation and false
68     * otherwise.
69     */
70    public boolean inPackage() {
71        return false;
72    }
73
74    /**
75     * Return true if this <code>Taglet</code>
76     * is used in type documentation (classes or interfaces).
77     * @return true if this <code>Taglet</code>
78     * is used in type documentation and false
79     * otherwise.
80     */
81    public boolean inType() {
82        return false;
83    }
84
85    /**
86     * Return true if this <code>Taglet</code>
87     * is an inline tag.
88     * @return true if this <code>Taglet</code>
89     * is an inline tag and false otherwise.
90     */
91    public boolean isInlineTag() {
92        return false;
93    }
94}
95