Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html@ccbe7ffdd867 (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html
Sun, 24 Feb 2013 11:36:58 -0800
- author
- jjg
- date
- Sun, 24 Feb 2013 11:36:58 -0800
- changeset 1606
- ccbe7ffdd867
- parent 554
- 9d9f26857129
- permissions
- -rw-r--r--
7112427: The doclet needs to be able to generate JavaFX documentation.
Reviewed-by: jjg
Contributed-by: jan.valenta@oracle.com
| 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.taglets package</title> |
| duke@1 | 29 | </head> |
| duke@1 | 30 | <body bgcolor="white"> |
| duke@1 | 31 | This package has classes used to generate Javadoc tag documentation. |
| duke@1 | 32 | Doclets no longer have to implement its own version of standard tags |
| duke@1 | 33 | such as @param and @throws. This is the single, doclet |
| duke@1 | 34 | implementation of each standard tag that is shared by all |
| duke@1 | 35 | doclets. Each doclet must have a taglet writer that takes a taglet |
| duke@1 | 36 | as input and writes doclet-dependent output. The taglet itself will |
| duke@1 | 37 | do the tag processing. For example, suppose we are outputing |
| duke@1 | 38 | @throws tags. The taglet would: |
| duke@1 | 39 | <ul> |
| duke@1 | 40 | <li> Retrieve the list of throws tags to be documented. |
| duke@1 | 41 | <li> Replace {@inheritDoc} with the appropriate documentation. |
| duke@1 | 42 | <li> Add throws documentation for exceptions that are declared in |
| duke@1 | 43 | the signature of the method but |
| duke@1 | 44 | not documented with the throws tags. |
| duke@1 | 45 | </ul> |
| duke@1 | 46 | After doing the steps above, the taglet would pass the information to |
| duke@1 | 47 | the taglet writer for writing. The taglets are essentially builders for |
| duke@1 | 48 | tags. |
| duke@1 | 49 | <p> |
| duke@1 | 50 | This code is not part of an API. |
| duke@1 | 51 | It is implementation that is subject to change. |
| duke@1 | 52 | Do not use it as an API. |
| duke@1 | 53 | </body> |
| duke@1 | 54 | </html> |
