Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java@b9e3b55a908c (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java
Mon, 14 Oct 2013 16:28:44 -0700
- author
- jjg
- date
- Mon, 14 Oct 2013 16:28:44 -0700
- changeset 2112
- b9e3b55a908c
- parent 554
- src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html@9d9f26857129
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8026371: "tidy" issues in langtools/src/**/*.html files
Reviewed-by: darcy
| jjg@2112 | 1 | /* |
| jjg@2112 | 2 | * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. |
| jjg@2112 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| jjg@2112 | 4 | * |
| jjg@2112 | 5 | * This code is free software; you can redistribute it and/or modify it |
| jjg@2112 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| jjg@2112 | 7 | * published by the Free Software Foundation. Oracle designates this |
| jjg@2112 | 8 | * particular file as subject to the "Classpath" exception as provided |
| jjg@2112 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| jjg@2112 | 10 | * |
| jjg@2112 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| jjg@2112 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| jjg@2112 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| jjg@2112 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| jjg@2112 | 15 | * accompanied this code). |
| jjg@2112 | 16 | * |
| jjg@2112 | 17 | * You should have received a copy of the GNU General Public License version |
| jjg@2112 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| jjg@2112 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| jjg@2112 | 20 | * |
| jjg@2112 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| jjg@2112 | 22 | * or visit www.oracle.com if you need additional information or have any |
| jjg@2112 | 23 | * questions. |
| jjg@2112 | 24 | */ |
| duke@1 | 25 | |
| jjg@2112 | 26 | /** |
| jjg@2112 | 27 | This package has classes used to generate Javadoc tag documentation. |
| jjg@2112 | 28 | Doclets no longer have to implement its own version of standard tags |
| jjg@2112 | 29 | such as @param and @throws. This is the single, doclet |
| jjg@2112 | 30 | implementation of each standard tag that is shared by all |
| jjg@2112 | 31 | doclets. Each doclet must have a taglet writer that takes a taglet |
| jjg@2112 | 32 | as input and writes doclet-dependent output. The taglet itself will |
| jjg@2112 | 33 | do the tag processing. For example, suppose we are outputing |
| jjg@2112 | 34 | @throws tags. The taglet would: |
| jjg@2112 | 35 | <ul> |
| jjg@2112 | 36 | <li> Retrieve the list of throws tags to be documented. |
| jjg@2112 | 37 | <li> Replace {@inheritDoc} with the appropriate documentation. |
| jjg@2112 | 38 | <li> Add throws documentation for exceptions that are declared in |
| jjg@2112 | 39 | the signature of the method but |
| jjg@2112 | 40 | not documented with the throws tags. |
| jjg@2112 | 41 | </ul> |
| jjg@2112 | 42 | After doing the steps above, the taglet would pass the information to |
| jjg@2112 | 43 | the taglet writer for writing. The taglets are essentially builders for |
| jjg@2112 | 44 | tags. |
| duke@1 | 45 | |
| jjg@2112 | 46 | <p><b>This is NOT part of any supported API. |
| jjg@2112 | 47 | If you write code that depends on this, you do so at your own risk. |
| jjg@2112 | 48 | This code and its internal interfaces are subject to change or |
| jjg@2112 | 49 | deletion without notice.</b> |
| jjg@2112 | 50 | */ |
| jjg@2112 | 51 | @jdk.Exported(false) |
| jjg@2112 | 52 | package com.sun.tools.doclets.internal.toolkit.taglets; |
