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 
  30 import com.sun.javadoc.Tag;
  31 import com.sun.tools.doclets.internal.toolkit.Content;
  32 
  33 
  34 /**
  35  * An inline Taglet used to denote literal text.
  36  * The enclosed text is interpreted as not containing HTML markup or
  37  * nested javadoc tags.
  38  * For example, the text:
  39  * <blockquote>  {@code {@literal a<B>c}}  </blockquote>
  40  * displays as:
  41  * <blockquote>  {@literal a<B>c}  </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  */
  51 
  52 public class LiteralTaglet extends BaseInlineTaglet {
  53 
  54     private static final String NAME = "literal";
  55 
  56     public static void register(Map<String, Taglet> map) {
  57         map.remove(NAME);
  58         map.put(NAME, new LiteralTaglet());
  59     }
  60 
  61     public String getName() {
  62         return NAME;
  63     }
  64 
  65     /**
  66      * {@inheritDoc}
  67      */
  68     public Content getTagletOutput(Tag tag, TagletWriter writer) {
  69         return writer.literalTagOutput(tag);
  70     }
  71 }

   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 javax.lang.model.element.Element;
  29 
  30 import com.sun.source.doctree.DocTree;
  31 import jdk.javadoc.internal.doclets.toolkit.Content;
  32 
  33 import static com.sun.source.doctree.DocTree.Kind.*;
  34 /**
  35  * An inline Taglet used to denote literal text.


  36  * For example, the text:
  37  * <blockquote>  {@code {@literal a<B>c}}  </blockquote>
  38  * displays as:
  39  * <blockquote>  {@literal a<B>c}  </blockquote>
  40  *
  41  *  <p><b>This is NOT part of any supported API.
  42  *  If you write code that depends on this, you do so at your own risk.
  43  *  This code and its internal interfaces are subject to change or
  44  *  deletion without notice.</b>
  45  *
  46  * @author Scott Seligman
  47  * @since 1.5
  48  */
  49 
  50 public class LiteralTaglet extends BaseInlineTaglet {
  51 
  52     private static final String NAME = LITERAL.tagName;
  53 





  54     public String getName() {
  55         return NAME;
  56     }
  57 
  58     /**
  59      * {@inheritDoc}
  60      */
  61     public Content getTagletOutput(Element e, DocTree tag, TagletWriter writer) {
  62         return writer.literalTagOutput(e, tag);
  63     }
  64 }