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

Tue, 18 Jun 2013 20:56:04 -0700

author
mfang
date
Tue, 18 Jun 2013 20:56:04 -0700
changeset 1841
792c40d5185a
parent 1751
ca8808c88f94
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8015657: jdk8 l10n resource file translation update 3
Reviewed-by: yhuang

     1 /*
     2  * Copyright (c) 2003, 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  */
    25 package com.sun.tools.doclets.internal.toolkit.taglets;
    27 import java.util.Map;
    29 import com.sun.javadoc.Tag;
    30 import com.sun.tools.doclets.internal.toolkit.Content;
    33 /**
    34  * An inline Taglet used to denote literal text.
    35  * The enclosed text is interpreted as not containing HTML markup or
    36  * nested javadoc tags.
    37  * For example, the text:
    38  * <blockquote>  {@code {@literal a<B>c}}  </blockquote>
    39  * displays as:
    40  * <blockquote>  {@literal a<B>c}  </blockquote>
    41  *
    42  *  <p><b>This is NOT part of any supported API.
    43  *  If you write code that depends on this, you do so at your own risk.
    44  *  This code and its internal interfaces are subject to change or
    45  *  deletion without notice.</b>
    46  *
    47  * @author Scott Seligman
    48  * @since 1.5
    49  */
    51 public class LiteralTaglet extends BaseInlineTaglet {
    53     private static final String NAME = "literal";
    55     public static void register(Map<String, Taglet> map) {
    56         map.remove(NAME);
    57         map.put(NAME, new LiteralTaglet());
    58     }
    60     public String getName() {
    61         return NAME;
    62     }
    64     /**
    65      * {@inheritDoc}
    66      */
    67     public Content getTagletOutput(Tag tag, TagletWriter writer) {
    68         return writer.literalTagOutput(tag);
    69     }
    70 }

mercurial