01: /*
02: * Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.doclets.internal.toolkit.taglets;
27:
28: import com.sun.javadoc.*;
29:
30: /**
31: * A taglet that represents the @deprecated tag.
32: *
33: * This code is not part of an API.
34: * It is implementation that is subject to change.
35: * Do not use it as an API
36: *
37: * @author Jamie Ho
38: * @since 1.5
39: */
40:
41: public class DeprecatedTaglet extends BaseTaglet {
42:
43: public DeprecatedTaglet() {
44: name = "deprecated";
45: }
46:
47: /**
48: * {@inheritDoc}
49: */
50: public boolean inPackage() {
51: return false;
52: }
53:
54: /**
55: * {@inheritDoc}
56: */
57: public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
58: return writer.deprecatedTagOutput(holder);
59: }
60: }
|