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