|
10
|
1 |
<!--
|
|
|
2 |
Copyright 2003 Sun Microsystems, Inc. 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. Sun designates this
|
|
|
8 |
particular file as subject to the "Classpath" exception as provided
|
|
|
9 |
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 |
<html>
|
|
|
27 |
<head>
|
|
|
28 |
<title>com.sun.tools.doclets.internal.toolkit package</title>
|
|
|
29 |
</head>
|
|
|
30 |
<body bgcolor="white">
|
|
|
31 |
|
|
|
32 |
Contains the base classes that make up a doclet. Doclets that reuse
|
|
|
33 |
the functionality provided by the toolkit should have the following
|
|
|
34 |
characteristics:
|
|
|
35 |
<ul>
|
|
|
36 |
<li>
|
|
|
37 |
The main driver class should extend
|
|
|
38 |
{@link com.sun.tools.doclets.internal.toolkit.AbstractDoclet}.
|
|
|
39 |
</li>
|
|
|
40 |
<li>
|
|
|
41 |
The doclet configuration class should extend
|
|
|
42 |
{@link com.sun.tools.doclets.internal.toolkit.Configuration}.
|
|
|
43 |
</li>
|
|
|
44 |
<li>
|
|
|
45 |
The doclet should have a writer factory that implements
|
|
|
46 |
{@link com.sun.tools.doclets.internal.toolkit.WriterFactory}.
|
|
|
47 |
This class constructs writers that write doclet specific output.
|
|
|
48 |
</li>
|
|
|
49 |
<li>
|
|
|
50 |
The doclet should have a taglet writer that extends
|
|
|
51 |
{@link com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter}.
|
|
|
52 |
This writer determines how to output each given tag.
|
|
|
53 |
</li>
|
|
|
54 |
</body>
|
|
|
55 |
</html>
|