src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/CodeTaglet.java

Sat, 07 Nov 2020 10:30:02 +0800

author
aoqi
date
Sat, 07 Nov 2020 10:30:02 +0800
changeset 3938
93012e2a5d1d
parent 2525
2eb010b6cb22
permissions
-rw-r--r--

Added tag mips-jdk8u275-b01 for changeset eb6ee6a5f2fe

aoqi@0 1 /*
aoqi@0 2 * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0 4 *
aoqi@0 5 * This code is free software; you can redistribute it and/or modify it
aoqi@0 6 * under the terms of the GNU General Public License version 2 only, as
aoqi@0 7 * published by the Free Software Foundation. Oracle designates this
aoqi@0 8 * particular file as subject to the "Classpath" exception as provided
aoqi@0 9 * by Oracle in the LICENSE file that accompanied this code.
aoqi@0 10 *
aoqi@0 11 * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0 14 * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0 15 * accompanied this code).
aoqi@0 16 *
aoqi@0 17 * You should have received a copy of the GNU General Public License version
aoqi@0 18 * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0 20 *
aoqi@0 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0 22 * or visit www.oracle.com if you need additional information or have any
aoqi@0 23 * questions.
aoqi@0 24 */
aoqi@0 25 package com.sun.tools.doclets.internal.toolkit.taglets;
aoqi@0 26
aoqi@0 27 import java.util.Map;
aoqi@0 28 import com.sun.javadoc.Tag;
aoqi@0 29 import com.sun.tools.doclets.internal.toolkit.Content;
aoqi@0 30
aoqi@0 31 /**
aoqi@0 32 * An inline Taglet used to denote literal code fragments.
aoqi@0 33 * The enclosed text is interpreted as not containing HTML markup or
aoqi@0 34 * nested javadoc tags, and is rendered in a font suitable for code.
aoqi@0 35 *
aoqi@0 36 * <p> The tag {@code {@code ...}} is equivalent to
aoqi@0 37 * {@code <code>{@literal ...}</code>}.
aoqi@0 38 * For example, the text:
aoqi@0 39 * <blockquote> The type {@code {@code List<P>}} </blockquote>
aoqi@0 40 * displays as:
aoqi@0 41 * <blockquote> The type {@code List<P>} </blockquote>
aoqi@0 42 *
aoqi@0 43 * <p><b>This is NOT part of any supported API.
aoqi@0 44 * If you write code that depends on this, you do so at your own risk.
aoqi@0 45 * This code and its internal interfaces are subject to change or
aoqi@0 46 * deletion without notice.</b>
aoqi@0 47 *
aoqi@0 48 * @author Scott Seligman
aoqi@0 49 * @since 1.5
aoqi@0 50 */
aoqi@0 51
aoqi@0 52 public class CodeTaglet extends BaseInlineTaglet {
aoqi@0 53
aoqi@0 54 private static final String NAME = "code";
aoqi@0 55
aoqi@0 56 public static void register(Map<String, Taglet> map) {
aoqi@0 57 map.remove(NAME);
aoqi@0 58 map.put(NAME, new CodeTaglet());
aoqi@0 59 }
aoqi@0 60
aoqi@0 61 public String getName() {
aoqi@0 62 return NAME;
aoqi@0 63 }
aoqi@0 64
aoqi@0 65 /**
aoqi@0 66 * {@inheritDoc}
aoqi@0 67 */
aoqi@0 68 public Content getTagletOutput(Tag tag, TagletWriter writer) {
aoqi@0 69 return writer.codeTagOutput(tag);
aoqi@0 70 }
aoqi@0 71 }

mercurial