Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html@c75be5bc5283 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html
Tue, 09 Oct 2012 19:10:00 -0700
- author
- jjg
- date
- Tue, 09 Oct 2012 19:10:00 -0700
- changeset 1357
- c75be5bc5283
- parent 554
- 9d9f26857129
- permissions
- -rw-r--r--
8000663: clean up langtools imports
Reviewed-by: darcy
| duke@1 | 1 | <!-- |
| ohair@554 | 2 | Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | |
| duke@1 | 5 | This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | |
| duke@1 | 11 | This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | accompanied this code). |
| duke@1 | 16 | |
| duke@1 | 17 | You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | |
| ohair@554 | 21 | Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | questions. |
| duke@1 | 24 | --> |
| duke@1 | 25 | |
| duke@1 | 26 | <html> |
| duke@1 | 27 | <head> |
| duke@1 | 28 | <title>com.sun.tools.doclets.internal.toolkit package</title> |
| duke@1 | 29 | </head> |
| duke@1 | 30 | <body bgcolor="white"> |
| duke@1 | 31 | |
| duke@1 | 32 | Contains the base classes that make up a doclet. Doclets that reuse |
| duke@1 | 33 | the functionality provided by the toolkit should have the following |
| duke@1 | 34 | characteristics: |
| duke@1 | 35 | <ul> |
| duke@1 | 36 | <li> |
| duke@1 | 37 | The main driver class should extend |
| duke@1 | 38 | {@link com.sun.tools.doclets.internal.toolkit.AbstractDoclet}. |
| duke@1 | 39 | </li> |
| duke@1 | 40 | <li> |
| duke@1 | 41 | The doclet configuration class should extend |
| duke@1 | 42 | {@link com.sun.tools.doclets.internal.toolkit.Configuration}. |
| duke@1 | 43 | </li> |
| duke@1 | 44 | <li> |
| duke@1 | 45 | The doclet should have a writer factory that implements |
| duke@1 | 46 | {@link com.sun.tools.doclets.internal.toolkit.WriterFactory}. |
| duke@1 | 47 | This class constructs writers that write doclet specific output. |
| duke@1 | 48 | </li> |
| duke@1 | 49 | <li> |
| duke@1 | 50 | The doclet should have a taglet writer that extends |
| duke@1 | 51 | {@link com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter}. |
| duke@1 | 52 | This writer determines how to output each given tag. |
| duke@1 | 53 | </li> |
| duke@1 | 54 | </body> |
| duke@1 | 55 | </html> |
