SummaryTaglet.java revision 4278:a6cee0419f93 
1/*
2 * Copyright (c) 2017, 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 */
25
26package jdk.javadoc.internal.doclets.toolkit.taglets;
27
28import javax.lang.model.element.Element;
29
30import com.sun.source.doctree.DocTree;
31import com.sun.source.doctree.SummaryTree;
32import jdk.javadoc.internal.doclets.toolkit.Content;
33
34import static com.sun.source.doctree.DocTree.Kind.*;
35
36/**
37 * A taglet that represents the @summary tag.
38 *
39 *  <p><b>This is NOT part of any supported API.
40 *  If you write code that depends on this, you do so at your own risk.
41 *  This code and its internal interfaces are subject to change or
42 *  deletion without notice.</b>
43 */
44
45public class SummaryTaglet extends BaseInlineTaglet {
46
47    public SummaryTaglet() {
48        name = SUMMARY.tagName;
49    }
50
51    /**
52     * {@inheritDoc}
53     */
54    public Content getTagletOutput(Element holder, DocTree tag, TagletWriter writer) {
55        return writer.commentTagsToOutput(holder, ((SummaryTree)tag).getSummary());
56    }
57}
58