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