Mercurial > jdk8-mips64-public > langtools / file diff

     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/CodeTaglet.java	Sat Dec 01 00:00:00 2007 +0000
     1.3 @@ -0,0 +1,65 @@
     1.4 +/*
     1.5 + * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
     1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.7 + *
     1.8 + * This code is free software; you can redistribute it and/or modify it
     1.9 + * under the terms of the GNU General Public License version 2 only, as
    1.10 + * published by the Free Software Foundation.  Sun designates this
    1.11 + * particular file as subject to the "Classpath" exception as provided
    1.12 + * by Sun in the LICENSE file that accompanied this code.
    1.13 + *
    1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
    1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    1.16 + * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    1.17 + * version 2 for more details (a copy is included in the LICENSE file that
    1.18 + * accompanied this code).
    1.19 + *
    1.20 + * You should have received a copy of the GNU General Public License version
    1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
    1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    1.23 + *
    1.24 + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    1.25 + * CA 95054 USA or visit www.sun.com if you need additional information or
    1.26 + * have any questions.
    1.27 + */
    1.28 +package com.sun.tools.doclets.internal.toolkit.taglets;
    1.29 +
    1.30 +import java.util.Map;
    1.31 +import com.sun.javadoc.Tag;
    1.32 +
    1.33 +/**
    1.34 + * An inline Taglet used to denote literal code fragments.
    1.35 + * The enclosed text is interpreted as not containing HTML markup or
    1.36 + * nested javadoc tags, and is rendered in a font suitable for code.
    1.37 + *
    1.38 + * <p> The tag {@code {@code ...}} is equivalent to
    1.39 + * {@code <code>{@literal ...}</code>}.
    1.40 + * For example, the text:
    1.41 + * <blockquote>  The type {@code {@code List<P>}}  </blockquote>
    1.42 + * displays as:
    1.43 + * <blockquote>  The type {@code List<P>}  </blockquote>
    1.44 + *
    1.45 + * @author Scott Seligman
    1.46 + * @since 1.5
    1.47 + */
    1.48 +
    1.49 +public class CodeTaglet extends LiteralTaglet {
    1.50 +
    1.51 +        private static final String NAME = "code";
    1.52 +
    1.53 +        public static void register(Map map) {
    1.54 +                map.remove(NAME);
    1.55 +                map.put(NAME, new CodeTaglet());
    1.56 +        }
    1.57 +
    1.58 +        public String getName() {
    1.59 +                return NAME;
    1.60 +        }
    1.61 +
    1.62 +        /*
    1.63 +         * Wraps @literal's result in a <code> element.
    1.64 +         */
    1.65 +        public String toString(Tag tag) {
    1.66 +                return "<code>" + super.toString(tag) + "</code>";
    1.67 +        }
    1.68 +}