OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [gnu-dev/] [or1k-gcc/] [libjava/] [classpath/] [tools/] [gnu/] [classpath/] [tools/] [taglets/] [VersionTaglet.java] - Blame information for rev 779

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 779 jeremybenn
/* gnu.classpath.tools.taglets.VersionTaglet
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
Linking this library statically or dynamically with other modules is
22
making a combined work based on this library.  Thus, the terms and
23
conditions of the GNU General Public License cover the whole
24
combination.
25
 
26
As a special exception, the copyright holders of this library give you
27
permission to link this library with independent modules to produce an
28
executable, regardless of the license terms of these independent
29
modules, and to copy and distribute the resulting executable under
30
terms of your choice, provided that you also meet, for each linked
31
independent module, the terms and conditions of the license of that
32
module.  An independent module is a module which is not derived from
33
or based on this library.  If you modify this library, you may extend
34
this exception to your version of the library, but you are not
35
obligated to do so.  If you do not wish to do so, delete this
36
exception statement from your version. */
37
 
38
package gnu.classpath.tools.taglets;
39
 
40
import java.util.Map;
41
 
42
import com.sun.tools.doclets.Taglet;
43
 
44
import com.sun.javadoc.Tag;
45
 
46
/**
47
 *  The default Taglet which handles version information.
48
 *
49
 *  @author Julian Scheid (julian@sektor37.de)
50
 */
51
public class VersionTaglet implements Taglet {
52
 
53
   private static final String NAME = "version";
54
   private static final String HEADER = "Version:";
55
 
56
   private static boolean enabled = true;
57
 
58
   public String getName() {
59
      return NAME;
60
   }
61
 
62
   public boolean inField() {
63
      return true;
64
   }
65
 
66
   public boolean inConstructor() {
67
      return true;
68
   }
69
 
70
   public boolean inMethod() {
71
      return true;
72
   }
73
 
74
   public boolean inOverview() {
75
      return true;
76
   }
77
 
78
   public boolean inPackage() {
79
      return true;
80
   }
81
 
82
   public boolean inType() {
83
      return true;
84
   }
85
 
86
   public boolean isInlineTag() {
87
      return false;
88
   }
89
 
90
   public static void register(Map tagletMap) {
91
      VersionTaglet versionTaglet = new VersionTaglet();
92
      tagletMap.put(versionTaglet.getName(), versionTaglet);
93
   }
94
 
95
   public String toString(Tag tag) {
96
      if (enabled) {
97
         return toString(new Tag[] { tag });
98
      }
99
      else {
100
         return null;
101
      }
102
   }
103
 
104
   public String toString(Tag[] tags) {
105
      if (!enabled || tags.length == 0) {
106
         return null;
107
      }
108
      else {
109
         boolean haveValidTag = false;
110
         for (int i = 0; i < tags.length && !haveValidTag; ++i) {
111
            if (tags[i].text().length() > 0) {
112
               haveValidTag = true;
113
            }
114
         }
115
 
116
         if (haveValidTag) {
117
 
118
            StringBuffer result = new StringBuffer();
119
            result.append("<dl class=\"tag list\">");
120
            result.append("</dl>");
121
            result.append("<dt class=\"tag section header\"><b>");
122
            result.append(HEADER);
123
            result.append("</b></dt><dd>");
124
            boolean firstEntry = true;
125
            for (int i = 0; i < tags.length; i++) {
126
               if (tags[i].text().length() > 0) {
127
                  if (!firstEntry) {
128
                     result.append(", ");
129
                  }
130
                  else {
131
                     firstEntry = false;
132
                  }
133
                  result.append(tags[i].text());
134
               }
135
            }
136
            result.append("</dd>");
137
            result.append("</dl>");
138
            return result.toString();
139
         }
140
         else {
141
            return null;
142
         }
143
      }
144
   }
145
 
146
   /**
147
    *  Enables/disables this taglet.
148
    */
149
   public static void setTagletEnabled(boolean enabled)
150
   {
151
      VersionTaglet.enabled = enabled;
152
   }
153
}

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.