duke@1: /*
jjg@1742:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
duke@1: import java.util.Map;
duke@1: import com.sun.javadoc.Tag;
jjg@1751: import com.sun.tools.doclets.internal.toolkit.Content;
duke@1: 
duke@1: /**
duke@1:  * An inline Taglet used to denote literal code fragments.
duke@1:  * The enclosed text is interpreted as not containing HTML markup or
duke@1:  * nested javadoc tags, and is rendered in a font suitable for code.
duke@1:  *
duke@1:  * <p> The tag {@code {@code ...}} is equivalent to
duke@1:  * {@code <code>{@literal ...}</code>}.
duke@1:  * For example, the text:
duke@1:  * <blockquote>  The type {@code {@code List<P>}}  </blockquote>
duke@1:  * displays as:
duke@1:  * <blockquote>  The type {@code List<P>}  </blockquote>
duke@1:  *
jjg@1359:  *  <p><b>This is NOT part of any supported API.
jjg@1359:  *  If you write code that depends on this, you do so at your own risk.
jjg@1359:  *  This code and its internal interfaces are subject to change or
jjg@1359:  *  deletion without notice.</b>
jjg@1359:  *
duke@1:  * @author Scott Seligman
duke@1:  * @since 1.5
duke@1:  */
duke@1: 
jjg@1742: public class CodeTaglet extends BaseInlineTaglet {
duke@1: 
jjg@1742:     private static final String NAME = "code";
duke@1: 
jjg@1742:     public static void register(Map<String, Taglet> map) {
jjg@1743:         map.remove(NAME);
jjg@1743:         map.put(NAME, new CodeTaglet());
jjg@1742:     }
duke@1: 
jjg@1742:     public String getName() {
jjg@1743:         return NAME;
jjg@1742:     }
duke@1: 
jjg@1742:     /**
jjg@1742:      * {@inheritDoc}
jjg@1742:      */
jjg@1751:     public Content getTagletOutput(Tag tag, TagletWriter writer) {
jjg@1742:         return writer.codeTagOutput(tag);
jjg@1742:     }
duke@1: }