Fri, 03 May 2013 17:44:38 -0700
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
Reviewed-by: jjg, mduigou
Contributed-by: jonathan.gibbons@oracle.com, mike.duigou@oracle.com
duke@1 | 1 | /* |
jjg@1724 | 2 | * Copyright (c) 2001, 2013, 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 | import com.sun.javadoc.*; |
jjg@1410 | 29 | import com.sun.tools.doclets.internal.toolkit.Configuration; |
duke@1 | 30 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 31 | |
duke@1 | 32 | /** |
duke@1 | 33 | * An inline Taglet representing the <b>inheritDoc</b> tag. This tag should only |
duke@1 | 34 | * be used with a method. It is used to inherit documentation from overriden |
duke@1 | 35 | * and implemented methods. |
duke@1 | 36 | * |
jjg@1359 | 37 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 38 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 39 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 40 | * deletion without notice.</b> |
duke@1 | 41 | * |
duke@1 | 42 | * @author Jamie Ho |
duke@1 | 43 | * @since 1.4 |
duke@1 | 44 | */ |
duke@1 | 45 | |
duke@1 | 46 | public class InheritDocTaglet extends BaseInlineTaglet { |
duke@1 | 47 | |
duke@1 | 48 | /** |
duke@1 | 49 | * The inline tag that would appear in the documentation if |
duke@1 | 50 | * the writer wanted documentation to be inherited. |
duke@1 | 51 | */ |
duke@1 | 52 | public static final String INHERIT_DOC_INLINE_TAG = "{@inheritDoc}"; |
duke@1 | 53 | |
duke@1 | 54 | /** |
duke@1 | 55 | * Construct a new InheritDocTaglet. |
duke@1 | 56 | */ |
duke@1 | 57 | public InheritDocTaglet () { |
duke@1 | 58 | name = "inheritDoc"; |
duke@1 | 59 | } |
duke@1 | 60 | |
duke@1 | 61 | /** |
duke@1 | 62 | * Will return false because this inline tag may |
jjg@1724 | 63 | * not appear in Fields. |
jjg@1724 | 64 | * @return false |
duke@1 | 65 | */ |
duke@1 | 66 | public boolean inField() { |
duke@1 | 67 | return false; |
duke@1 | 68 | } |
duke@1 | 69 | |
duke@1 | 70 | /** |
duke@1 | 71 | * Will return false because this inline tag may |
jjg@1724 | 72 | * not appear in Constructors. |
jjg@1724 | 73 | * @return false |
duke@1 | 74 | */ |
duke@1 | 75 | public boolean inConstructor() { |
duke@1 | 76 | return false; |
duke@1 | 77 | } |
duke@1 | 78 | |
duke@1 | 79 | /** |
duke@1 | 80 | * Will return false because this inline tag may |
jjg@1724 | 81 | * not appear in Overview. |
jjg@1724 | 82 | * @return false |
duke@1 | 83 | */ |
duke@1 | 84 | public boolean inOverview() { |
duke@1 | 85 | return false; |
duke@1 | 86 | } |
duke@1 | 87 | |
duke@1 | 88 | /** |
duke@1 | 89 | * Will return false because this inline tag may |
jjg@1724 | 90 | * not appear in Packages. |
jjg@1724 | 91 | * @return false |
duke@1 | 92 | */ |
duke@1 | 93 | public boolean inPackage() { |
duke@1 | 94 | return false; |
duke@1 | 95 | } |
duke@1 | 96 | |
duke@1 | 97 | /** |
jjg@1724 | 98 | * Will return true because this inline tag may |
jjg@1724 | 99 | * appear in Type (Class). |
jjg@1724 | 100 | * @return true |
duke@1 | 101 | */ |
duke@1 | 102 | public boolean inType() { |
jjg@1724 | 103 | return true; |
duke@1 | 104 | } |
duke@1 | 105 | |
duke@1 | 106 | /** |
duke@1 | 107 | * Given a <code>MethodDoc</code> item, a <code>Tag</code> in the |
jjg@1410 | 108 | * <code>MethodDoc</code> item and a String, replace all occurrences |
duke@1 | 109 | * of @inheritDoc with documentation from it's superclass or superinterface. |
duke@1 | 110 | * |
duke@1 | 111 | * @param writer the writer that is writing the output. |
jjg@1724 | 112 | * @param ped the {@link ProgramElementDoc} that we are documenting. |
jjg@1724 | 113 | * @param holderTag the tag that holds the inheritDoc tag or null for type |
jjg@1724 | 114 | * (class) docs. |
duke@1 | 115 | * @param isFirstSentence true if we only want to inherit the first sentence. |
duke@1 | 116 | */ |
duke@1 | 117 | private TagletOutput retrieveInheritedDocumentation(TagletWriter writer, |
jjg@1724 | 118 | ProgramElementDoc ped, Tag holderTag, boolean isFirstSentence) { |
duke@1 | 119 | TagletOutput replacement = writer.getTagletOutputInstance(); |
duke@1 | 120 | |
jjg@1410 | 121 | Configuration configuration = writer.configuration(); |
duke@1 | 122 | Taglet inheritableTaglet = holderTag == null ? |
jjg@1410 | 123 | null : configuration.tagletManager.getTaglet(holderTag.name()); |
duke@1 | 124 | if (inheritableTaglet != null && |
duke@1 | 125 | !(inheritableTaglet instanceof InheritableTaglet)) { |
jjg@1724 | 126 | String message = ped.name() + |
jjg@1724 | 127 | ((ped instanceof ExecutableMemberDoc) |
jjg@1724 | 128 | ? ((ExecutableMemberDoc)ped).flatSignature() |
jjg@1724 | 129 | : ""); |
duke@1 | 130 | //This tag does not support inheritence. |
jjg@1724 | 131 | configuration.message.warning(ped.position(), |
jjg@1724 | 132 | "doclet.noInheritedDoc", message); |
duke@1 | 133 | } |
duke@1 | 134 | DocFinder.Output inheritedDoc = |
jjg@1724 | 135 | DocFinder.search(new DocFinder.Input(ped, |
duke@1 | 136 | (InheritableTaglet) inheritableTaglet, holderTag, |
duke@1 | 137 | isFirstSentence, true)); |
jjg@1724 | 138 | if (inheritedDoc.isValidInheritDocTag) { |
jjg@1724 | 139 | if (inheritedDoc.inlineTags.length > 0) { |
jjg@1724 | 140 | replacement = writer.commentTagsToOutput(inheritedDoc.holderTag, |
jjg@1724 | 141 | inheritedDoc.holder, inheritedDoc.inlineTags, isFirstSentence); |
jjg@1724 | 142 | } |
jjg@1724 | 143 | } else { |
jjg@1724 | 144 | String message = ped.name() + |
jjg@1724 | 145 | ((ped instanceof ExecutableMemberDoc) |
jjg@1724 | 146 | ? ((ExecutableMemberDoc)ped).flatSignature() |
jjg@1724 | 147 | : ""); |
jjg@1724 | 148 | configuration.message.warning(ped.position(), |
jjg@1724 | 149 | "doclet.noInheritedDoc", message); |
duke@1 | 150 | } |
duke@1 | 151 | return replacement; |
duke@1 | 152 | } |
duke@1 | 153 | |
duke@1 | 154 | /** |
duke@1 | 155 | * Given the <code>Tag</code> representation of this custom |
duke@1 | 156 | * tag, return its string representation, which is output |
duke@1 | 157 | * to the generated page. |
duke@1 | 158 | * @param tag the <code>Tag</code> representation of this custom tag. |
duke@1 | 159 | * @param tagletWriter the taglet writer for output. |
duke@1 | 160 | * @return the TagletOutput representation of this <code>Tag</code>. |
duke@1 | 161 | */ |
duke@1 | 162 | public TagletOutput getTagletOutput(Tag tag, TagletWriter tagletWriter) { |
jjg@1724 | 163 | if (! (tag.holder() instanceof ProgramElementDoc)) { |
duke@1 | 164 | return tagletWriter.getOutputInstance(); |
duke@1 | 165 | } |
duke@1 | 166 | return tag.name().equals("@inheritDoc") ? |
jjg@1724 | 167 | retrieveInheritedDocumentation(tagletWriter, (ProgramElementDoc) tag.holder(), null, tagletWriter.isFirstSentence) : |
jjg@1724 | 168 | retrieveInheritedDocumentation(tagletWriter, (ProgramElementDoc) tag.holder(), tag, tagletWriter.isFirstSentence); |
duke@1 | 169 | } |
duke@1 | 170 | } |