Tue, 15 Jul 2008 19:22:51 -0700
6657907: javadoc has unchecked warnings
Reviewed-by: bpatel
1 /*
2 * Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package com.sun.tools.doclets.internal.toolkit.taglets;
27 import java.util.Map;
28 import com.sun.javadoc.Tag;
29 import com.sun.tools.doclets.Taglet;
31 /**
32 * An inline Taglet used to denote literal code fragments.
33 * The enclosed text is interpreted as not containing HTML markup or
34 * nested javadoc tags, and is rendered in a font suitable for code.
35 *
36 * <p> The tag {@code {@code ...}} is equivalent to
37 * {@code <code>{@literal ...}</code>}.
38 * For example, the text:
39 * <blockquote> The type {@code {@code List<P>}} </blockquote>
40 * displays as:
41 * <blockquote> The type {@code List<P>} </blockquote>
42 *
43 * @author Scott Seligman
44 * @since 1.5
45 */
47 public class CodeTaglet extends LiteralTaglet {
49 private static final String NAME = "code";
51 public static void register(Map<String, Taglet> map) {
52 map.remove(NAME);
53 map.put(NAME, new CodeTaglet());
54 }
56 public String getName() {
57 return NAME;
58 }
60 /*
61 * Wraps @literal's result in a <code> element.
62 */
63 public String toString(Tag tag) {
64 return "<code>" + super.toString(tag) + "</code>";
65 }
66 }