aoqi@0: /*
aoqi@0:  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit.taglets;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A taglet that represents the @see tag.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Jamie Ho
aoqi@0:  * @since 1.4
aoqi@0:  */
aoqi@0: public class SeeTaglet extends BaseTaglet implements InheritableTaglet {
aoqi@0: 
aoqi@0:     public SeeTaglet() {
aoqi@0:         name = "see";
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public void inherit(DocFinder.Input input, DocFinder.Output output) {
aoqi@0:         Tag[] tags = input.element.seeTags();
aoqi@0:         if (tags.length > 0) {
aoqi@0:             output.holder = input.element;
aoqi@0:             output.holderTag = tags[0];
aoqi@0:             output.inlineTags = input.isFirstSentence ?
aoqi@0:                 tags[0].firstSentenceTags() : tags[0].inlineTags();
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     public Content getTagletOutput(Doc holder, TagletWriter writer) {
aoqi@0:         SeeTag[] tags = holder.seeTags();
aoqi@0:         if (tags.length == 0 && holder instanceof MethodDoc) {
aoqi@0:             DocFinder.Output inheritedDoc =
aoqi@0:                 DocFinder.search(new DocFinder.Input((MethodDoc) holder, this));
aoqi@0:             if (inheritedDoc.holder != null) {
aoqi@0:                 tags = inheritedDoc.holder.seeTags();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return writer.seeTagOutput(holder, tags);
aoqi@0:     }
aoqi@0: }