libjava/classpath/tools/gnu/classpath/tools/taglets/CodeTaglet.java

   1 /* gnu.classpath.tools.taglets.CodeTaglet
   2    Copyright (C) 2001 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA. */
  20
  21 package gnu.classpath.tools.taglets;
  22
  23 import java.util.Map;
  24
  25 import com.sun.tools.doclets.Taglet;
  26
  27 import com.sun.javadoc.Doc;
  28 import com.sun.javadoc.Tag;
  29 import com.sun.javadoc.FieldDoc;
  30 import com.sun.javadoc.MemberDoc;
  31 import com.sun.javadoc.SeeTag;
  32
  33 /**
  34  *  The default Taglet which shows its contents enclosed in a
  35  *  <code>code</code> tag.
  36  *
  37  *  @author Julian Scheid (julian@sektor37.de)
  38  */
  39 public class CodeTaglet
  40    implements Taglet
  41 {
  42    private static final String NAME = "code";
  43
  44    public String getName() {
  45       return NAME;
  46    }
  47
  48    public boolean inField() {
  49       return true;
  50    }
  51
  52    public boolean inConstructor() {
  53       return true;
  54    }
  55
  56    public boolean inMethod() {
  57       return true;
  58    }
  59
  60    public boolean inOverview() {
  61       return true;
  62    }
  63
  64    public boolean inPackage() {
  65       return true;
  66    }
  67
  68    public boolean inType() {
  69       return true;
  70    }
  71
  72    public boolean isInlineTag() {
  73       return true;
  74    }
  75
  76    public String toString(Tag tag) {
  77       return "<code>" + tag.text() + "</code>";
  78    }
  79
  80    public String toString(Tag[] tag) {
  81       return null;
  82    }
  83
  84 }