jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html@24a47c3062fe

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

     1 <!--

     2  Copyright 2003 Sun Microsystems, Inc.  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.  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.

    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 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 -->

    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 &#64;param and &#64;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         &#64;throws tags. The taglet would:

    39         <ul>

    40             <li> Retrieve the list of throws tags to be documented.

    41             <li> Replace {&#64;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>

Mercurial > jdk8-mips64-public > langtools / file revision