Tue, 14 May 2013 10:14:57 -0700
8012308: Remove TagletOutput in favor of direct use of Content
Reviewed-by: darcy
1 /*
2 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.doclets.internal.toolkit.taglets;
28 import com.sun.javadoc.*;
29 import com.sun.tools.doclets.internal.toolkit.Content;
30 import com.sun.tools.doclets.internal.toolkit.util.*;
32 /**
33 * A taglet that represents the @see tag.
34 *
35 * <p><b>This is NOT part of any supported API.
36 * If you write code that depends on this, you do so at your own risk.
37 * This code and its internal interfaces are subject to change or
38 * deletion without notice.</b>
39 *
40 * @author Jamie Ho
41 * @since 1.4
42 */
43 public class SeeTaglet extends BaseTaglet implements InheritableTaglet {
45 public SeeTaglet() {
46 name = "see";
47 }
49 /**
50 * {@inheritDoc}
51 */
52 public void inherit(DocFinder.Input input, DocFinder.Output output) {
53 Tag[] tags = input.element.seeTags();
54 if (tags.length > 0) {
55 output.holder = input.element;
56 output.holderTag = tags[0];
57 output.inlineTags = input.isFirstSentence ?
58 tags[0].firstSentenceTags() : tags[0].inlineTags();
59 }
60 }
62 /**
63 * {@inheritDoc}
64 */
65 public Content getTagletOutput(Doc holder, TagletWriter writer) {
66 SeeTag[] tags = holder.seeTags();
67 if (tags.length == 0 && holder instanceof MethodDoc) {
68 DocFinder.Output inheritedDoc =
69 DocFinder.search(new DocFinder.Input((MethodDoc) holder, this));
70 if (inheritedDoc.holder != null) {
71 tags = inheritedDoc.holder.seeTags();
72 }
73 }
74 return writer.seeTagOutput(holder, tags);
75 }
76 }