jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/CodeTaglet.java@ccbe7ffdd867

7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com

     1 /*

     2  * Copyright (c) 2003, 2012, 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;

    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  *  <p><b>This is NOT part of any supported API.

    44  *  If you write code that depends on this, you do so at your own risk.

    45  *  This code and its internal interfaces are subject to change or

    46  *  deletion without notice.</b>

    47  *

    48  * @author Scott Seligman

    49  * @since 1.5

    50  */

    52 public class CodeTaglet extends LiteralTaglet {

    54         private static final String NAME = "code";

    56         public static void register(Map<String, Taglet> map) {

    57                 map.remove(NAME);

    58                 map.put(NAME, new CodeTaglet());

    59         }

    61         public String getName() {

    62                 return NAME;

    63         }

    65         /*

    66          * Wraps @literal's result in a <code> element.

    67          */

    68         public String toString(Tag tag) {

    69                 return "<code>" + super.toString(tag) + "</code>";

    70         }

    71 }

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