1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package.html Sat Dec 01 00:00:00 2007 +0000
1.3 @@ -0,0 +1,54 @@
1.4 +<!--
1.5 + Copyright 2003 Sun Microsystems, Inc. All Rights Reserved.
1.6 + DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 +
1.8 + This code is free software; you can redistribute it and/or modify it
1.9 + under the terms of the GNU General Public License version 2 only, as
1.10 + published by the Free Software Foundation. Sun designates this
1.11 + particular file as subject to the "Classpath" exception as provided
1.12 + by Sun in the LICENSE file that accompanied this code.
1.13 +
1.14 + This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + version 2 for more details (a copy is included in the LICENSE file that
1.18 + accompanied this code).
1.19 +
1.20 + You should have received a copy of the GNU General Public License version
1.21 + 2 along with this work; if not, write to the Free Software Foundation,
1.22 + Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 +
1.24 + Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
1.25 + CA 95054 USA or visit www.sun.com if you need additional information or
1.26 + have any questions.
1.27 +-->
1.28 +
1.29 +<html>
1.30 +<head>
1.31 +<title>com.sun.tools.doclets.internal.toolkit.taglets package</title>
1.32 +</head>
1.33 +<body bgcolor="white">
1.34 + This package has classes used to generate Javadoc tag documentation.
1.35 + Doclets no longer have to implement its own version of standard tags
1.36 + such as @param and @throws. This is the single, doclet
1.37 + implementation of each standard tag that is shared by all
1.38 + doclets. Each doclet must have a taglet writer that takes a taglet
1.39 + as input and writes doclet-dependent output. The taglet itself will
1.40 + do the tag processing. For example, suppose we are outputing
1.41 + @throws tags. The taglet would:
1.42 + <ul>
1.43 + <li> Retrieve the list of throws tags to be documented.
1.44 + <li> Replace {@inheritDoc} with the appropriate documentation.
1.45 + <li> Add throws documentation for exceptions that are declared in
1.46 + the signature of the method but
1.47 + not documented with the throws tags.
1.48 + </ul>
1.49 + After doing the steps above, the taglet would pass the information to
1.50 + the taglet writer for writing. The taglets are essentially builders for
1.51 + tags.
1.52 + <p>
1.53 + This code is not part of an API.
1.54 + It is implementation that is subject to change.
1.55 + Do not use it as an API.
1.56 + </body>
1.57 +</html>
