CodeTaglet.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2003, 2016, 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 java.util.Map;
29
30import javax.lang.model.element.Element;
31
32import com.sun.source.doctree.DocTree;
33import jdk.javadoc.internal.doclets.toolkit.Content;
34
35import static com.sun.source.doctree.DocTree.Kind.*;
36
37/**
38 * An inline Taglet used to denote literal code fragments.
39 * The enclosed text is interpreted as not containing HTML markup or
40 * nested javadoc tags, and is rendered in a font suitable for code.
41 *
42 * <p> The tag {@code {@code ...}} is equivalent to
43 * {@code <code>{@literal ...}</code>}.
44 * For example, the text:
45 * <blockquote>  The type {@code {@code List<P>}}  </blockquote>
46 * displays as:
47 * <blockquote>  The type {@code List<P>}  </blockquote>
48 *
49 *  <p><b>This is NOT part of any supported API.
50 *  If you write code that depends on this, you do so at your own risk.
51 *  This code and its internal interfaces are subject to change or
52 *  deletion without notice.</b>
53 *
54 * @author Scott Seligman
55 */
56
57public class CodeTaglet extends BaseInlineTaglet {
58
59    private static final String NAME = CODE.tagName;
60
61    public String getName() {
62        return NAME;
63    }
64
65    /**
66     * {@inheritDoc}
67     */
68    public Content getTagletOutput(Element element, DocTree tag, TagletWriter writer) {
69        return writer.codeTagOutput(element, tag);
70    }
71}
72