Tue, 25 May 2010 15:54:51 -0700
6943119: Rebrand source copyright notices
Reviewed-by: darcy
1 <!--
2 Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
3 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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.
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).
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.
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 -->
26 <html>
27 <head>
28 <title>com.sun.tools.doclets.internal.toolkit.taglets package</title>
29 </head>
30 <body bgcolor="white">
31 This package has classes used to generate Javadoc tag documentation.
32 Doclets no longer have to implement its own version of standard tags
33 such as @param and @throws. This is the single, doclet
34 implementation of each standard tag that is shared by all
35 doclets. Each doclet must have a taglet writer that takes a taglet
36 as input and writes doclet-dependent output. The taglet itself will
37 do the tag processing. For example, suppose we are outputing
38 @throws tags. The taglet would:
39 <ul>
40 <li> Retrieve the list of throws tags to be documented.
41 <li> Replace {@inheritDoc} with the appropriate documentation.
42 <li> Add throws documentation for exceptions that are declared in
43 the signature of the method but
44 not documented with the throws tags.
45 </ul>
46 After doing the steps above, the taglet would pass the information to
47 the taglet writer for writing. The taglets are essentially builders for
48 tags.
49 <p>
50 This code is not part of an API.
51 It is implementation that is subject to change.
52 Do not use it as an API.
53 </body>
54 </html>