duke@1: /*
ohair@554: * Copyright (c) 2001, 2005, Oracle and/or its affiliates. All rights reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
ohair@554: * published by the Free Software Foundation. Oracle designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
ohair@554: * by Oracle in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554: * or visit www.oracle.com if you need additional information or have any
ohair@554: * questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1:
duke@1: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1:
duke@1: /**
duke@1: * An inline Taglet representing the inheritDoc tag. This tag should only
duke@1: * be used with a method. It is used to inherit documentation from overriden
duke@1: * and implemented methods.
duke@1: *
duke@1: * This code is not part of an API.
duke@1: * It is implementation that is subject to change.
duke@1: * Do not use it as an API
duke@1: *
duke@1: * @author Jamie Ho
duke@1: * @since 1.4
duke@1: */
duke@1:
duke@1: public class InheritDocTaglet extends BaseInlineTaglet {
duke@1:
duke@1: /**
duke@1: * The inline tag that would appear in the documentation if
duke@1: * the writer wanted documentation to be inherited.
duke@1: */
duke@1: public static final String INHERIT_DOC_INLINE_TAG = "{@inheritDoc}";
duke@1:
duke@1: /**
duke@1: * Construct a new InheritDocTaglet.
duke@1: */
duke@1: public InheritDocTaglet () {
duke@1: name = "inheritDoc";
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Methods.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inField() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Methods.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inConstructor() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Methods.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inOverview() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Methods.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inPackage() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Will return false because this inline tag may
duke@1: * only appear in Methods.
duke@1: * @return false since this is not a method.
duke@1: */
duke@1: public boolean inType() {
duke@1: return false;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Given a MethodDoc
item, a Tag
in the
duke@1: * MethodDoc
item and a String, replace all occurances
duke@1: * of @inheritDoc with documentation from it's superclass or superinterface.
duke@1: *
duke@1: * @param writer the writer that is writing the output.
duke@1: * @param md the {@link MethodDoc} that we are documenting.
duke@1: * @param holderTag the tag that holds the inheritDoc tag.
duke@1: * @param isFirstSentence true if we only want to inherit the first sentence.
duke@1: */
duke@1: private TagletOutput retrieveInheritedDocumentation(TagletWriter writer,
duke@1: MethodDoc md, Tag holderTag, boolean isFirstSentence) {
duke@1: TagletOutput replacement = writer.getTagletOutputInstance();
duke@1:
duke@1: Taglet inheritableTaglet = holderTag == null ?
duke@1: null : writer.configuration().tagletManager.getTaglet(holderTag.name());
duke@1: if (inheritableTaglet != null &&
duke@1: !(inheritableTaglet instanceof InheritableTaglet)) {
duke@1: //This tag does not support inheritence.
duke@1: writer.configuration().message.warning(md.position(),
duke@1: "doclet.noInheritedDoc", md.name() + md.flatSignature());
duke@1: }
duke@1: DocFinder.Output inheritedDoc =
duke@1: DocFinder.search(new DocFinder.Input(md,
duke@1: (InheritableTaglet) inheritableTaglet, holderTag,
duke@1: isFirstSentence, true));
duke@1: if (inheritedDoc.isValidInheritDocTag == false) {
duke@1: writer.configuration().message.warning(md.position(),
duke@1: "doclet.noInheritedDoc", md.name() + md.flatSignature());
duke@1: } else if (inheritedDoc.inlineTags.length > 0) {
duke@1: replacement = writer.commentTagsToOutput(inheritedDoc.holderTag,
duke@1: inheritedDoc.holder, inheritedDoc.inlineTags, isFirstSentence);
duke@1: }
duke@1: return replacement;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Given the Tag
representation of this custom
duke@1: * tag, return its string representation, which is output
duke@1: * to the generated page.
duke@1: * @param tag the Tag
representation of this custom tag.
duke@1: * @param tagletWriter the taglet writer for output.
duke@1: * @return the TagletOutput representation of this Tag
.
duke@1: */
duke@1: public TagletOutput getTagletOutput(Tag tag, TagletWriter tagletWriter) {
duke@1: if (! (tag.holder() instanceof MethodDoc)) {
duke@1: return tagletWriter.getOutputInstance();
duke@1: }
duke@1: return tag.name().equals("@inheritDoc") ?
duke@1: retrieveInheritedDocumentation(tagletWriter, (MethodDoc) tag.holder(), null, tagletWriter.isFirstSentence) :
duke@1: retrieveInheritedDocumentation(tagletWriter, (MethodDoc) tag.holder(), tag, tagletWriter.isFirstSentence);
duke@1: }
duke@1: }