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