Sat, 01 Dec 2007 00:00:00 +0000
Initial load
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2001-2005 Sun Microsystems, Inc. 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 |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun 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 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.javadoc.*; |
duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 30 | |
duke@1 | 31 | /** |
duke@1 | 32 | * An inline Taglet representing the <b>inheritDoc</b> tag. This tag should only |
duke@1 | 33 | * be used with a method. It is used to inherit documentation from overriden |
duke@1 | 34 | * and implemented methods. |
duke@1 | 35 | * |
duke@1 | 36 | * This code is not part of an API. |
duke@1 | 37 | * It is implementation that is subject to change. |
duke@1 | 38 | * Do not use it as an API |
duke@1 | 39 | * |
duke@1 | 40 | * @author Jamie Ho |
duke@1 | 41 | * @since 1.4 |
duke@1 | 42 | */ |
duke@1 | 43 | |
duke@1 | 44 | public class InheritDocTaglet extends BaseInlineTaglet { |
duke@1 | 45 | |
duke@1 | 46 | /** |
duke@1 | 47 | * The inline tag that would appear in the documentation if |
duke@1 | 48 | * the writer wanted documentation to be inherited. |
duke@1 | 49 | */ |
duke@1 | 50 | public static final String INHERIT_DOC_INLINE_TAG = "{@inheritDoc}"; |
duke@1 | 51 | |
duke@1 | 52 | /** |
duke@1 | 53 | * Construct a new InheritDocTaglet. |
duke@1 | 54 | */ |
duke@1 | 55 | public InheritDocTaglet () { |
duke@1 | 56 | name = "inheritDoc"; |
duke@1 | 57 | } |
duke@1 | 58 | |
duke@1 | 59 | /** |
duke@1 | 60 | * Will return false because this inline tag may |
duke@1 | 61 | * only appear in Methods. |
duke@1 | 62 | * @return false since this is not a method. |
duke@1 | 63 | */ |
duke@1 | 64 | public boolean inField() { |
duke@1 | 65 | return false; |
duke@1 | 66 | } |
duke@1 | 67 | |
duke@1 | 68 | /** |
duke@1 | 69 | * Will return false because this inline tag may |
duke@1 | 70 | * only appear in Methods. |
duke@1 | 71 | * @return false since this is not a method. |
duke@1 | 72 | */ |
duke@1 | 73 | public boolean inConstructor() { |
duke@1 | 74 | return false; |
duke@1 | 75 | } |
duke@1 | 76 | |
duke@1 | 77 | /** |
duke@1 | 78 | * Will return false because this inline tag may |
duke@1 | 79 | * only appear in Methods. |
duke@1 | 80 | * @return false since this is not a method. |
duke@1 | 81 | */ |
duke@1 | 82 | public boolean inOverview() { |
duke@1 | 83 | return false; |
duke@1 | 84 | } |
duke@1 | 85 | |
duke@1 | 86 | /** |
duke@1 | 87 | * Will return false because this inline tag may |
duke@1 | 88 | * only appear in Methods. |
duke@1 | 89 | * @return false since this is not a method. |
duke@1 | 90 | */ |
duke@1 | 91 | public boolean inPackage() { |
duke@1 | 92 | return false; |
duke@1 | 93 | } |
duke@1 | 94 | |
duke@1 | 95 | /** |
duke@1 | 96 | * Will return false because this inline tag may |
duke@1 | 97 | * only appear in Methods. |
duke@1 | 98 | * @return false since this is not a method. |
duke@1 | 99 | */ |
duke@1 | 100 | public boolean inType() { |
duke@1 | 101 | return false; |
duke@1 | 102 | } |
duke@1 | 103 | |
duke@1 | 104 | /** |
duke@1 | 105 | * Given a <code>MethodDoc</code> item, a <code>Tag</code> in the |
duke@1 | 106 | * <code>MethodDoc</code> item and a String, replace all occurances |
duke@1 | 107 | * of @inheritDoc with documentation from it's superclass or superinterface. |
duke@1 | 108 | * |
duke@1 | 109 | * @param writer the writer that is writing the output. |
duke@1 | 110 | * @param md the {@link MethodDoc} that we are documenting. |
duke@1 | 111 | * @param holderTag the tag that holds the inheritDoc tag. |
duke@1 | 112 | * @param isFirstSentence true if we only want to inherit the first sentence. |
duke@1 | 113 | */ |
duke@1 | 114 | private TagletOutput retrieveInheritedDocumentation(TagletWriter writer, |
duke@1 | 115 | MethodDoc md, Tag holderTag, boolean isFirstSentence) { |
duke@1 | 116 | TagletOutput replacement = writer.getTagletOutputInstance(); |
duke@1 | 117 | |
duke@1 | 118 | Taglet inheritableTaglet = holderTag == null ? |
duke@1 | 119 | null : writer.configuration().tagletManager.getTaglet(holderTag.name()); |
duke@1 | 120 | if (inheritableTaglet != null && |
duke@1 | 121 | !(inheritableTaglet instanceof InheritableTaglet)) { |
duke@1 | 122 | //This tag does not support inheritence. |
duke@1 | 123 | writer.configuration().message.warning(md.position(), |
duke@1 | 124 | "doclet.noInheritedDoc", md.name() + md.flatSignature()); |
duke@1 | 125 | } |
duke@1 | 126 | DocFinder.Output inheritedDoc = |
duke@1 | 127 | DocFinder.search(new DocFinder.Input(md, |
duke@1 | 128 | (InheritableTaglet) inheritableTaglet, holderTag, |
duke@1 | 129 | isFirstSentence, true)); |
duke@1 | 130 | if (inheritedDoc.isValidInheritDocTag == false) { |
duke@1 | 131 | writer.configuration().message.warning(md.position(), |
duke@1 | 132 | "doclet.noInheritedDoc", md.name() + md.flatSignature()); |
duke@1 | 133 | } else if (inheritedDoc.inlineTags.length > 0) { |
duke@1 | 134 | replacement = writer.commentTagsToOutput(inheritedDoc.holderTag, |
duke@1 | 135 | inheritedDoc.holder, inheritedDoc.inlineTags, isFirstSentence); |
duke@1 | 136 | } |
duke@1 | 137 | return replacement; |
duke@1 | 138 | } |
duke@1 | 139 | |
duke@1 | 140 | /** |
duke@1 | 141 | * Given the <code>Tag</code> representation of this custom |
duke@1 | 142 | * tag, return its string representation, which is output |
duke@1 | 143 | * to the generated page. |
duke@1 | 144 | * @param tag the <code>Tag</code> representation of this custom tag. |
duke@1 | 145 | * @param tagletWriter the taglet writer for output. |
duke@1 | 146 | * @return the TagletOutput representation of this <code>Tag</code>. |
duke@1 | 147 | */ |
duke@1 | 148 | public TagletOutput getTagletOutput(Tag tag, TagletWriter tagletWriter) { |
duke@1 | 149 | if (! (tag.holder() instanceof MethodDoc)) { |
duke@1 | 150 | return tagletWriter.getOutputInstance(); |
duke@1 | 151 | } |
duke@1 | 152 | return tag.name().equals("@inheritDoc") ? |
duke@1 | 153 | retrieveInheritedDocumentation(tagletWriter, (MethodDoc) tag.holder(), null, tagletWriter.isFirstSentence) : |
duke@1 | 154 | retrieveInheritedDocumentation(tagletWriter, (MethodDoc) tag.holder(), tag, tagletWriter.isFirstSentence); |
duke@1 | 155 | } |
duke@1 | 156 | } |