Mercurial Mercurial > jdk-sandbox / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
langtools/src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 10 06bc494ca11e
child 5520 86e4b9a9da40
permissions -rw-r--r--
Initial load

<!--
 Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 This code is free software; you can redistribute it and/or modify it
 under the terms of the GNU General Public License version 2 only, as
 published by the Free Software Foundation.  Sun designates this
 particular file as subject to the "Classpath" exception as provided
 by Sun in the LICENSE file that accompanied this code.

 This code is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 version 2 for more details (a copy is included in the LICENSE file that
 accompanied this code).

 You should have received a copy of the GNU General Public License version
 2 along with this work; if not, write to the Free Software Foundation,
 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 CA 95054 USA or visit www.sun.com if you need additional information or
 have any questions.
-->

<html>
<head>
<title>com.sun.tools.doclets.internal.toolkit package</title>
</head>
<body bgcolor="white">

        Contains the base classes that make up a doclet.  Doclets that reuse
        the functionality provided by the toolkit should have the following
        characteristics:
        <ul>
            <li> 
                The main driver class should extend 
                {@link com.sun.tools.doclets.internal.toolkit.AbstractDoclet}.
            </li>
            <li> 
                The doclet configuration class should extend 
                {@link com.sun.tools.doclets.internal.toolkit.Configuration}.
            </li>
            <li> 
                The doclet should have a writer factory that implements
                {@link com.sun.tools.doclets.internal.toolkit.WriterFactory}.  
                This class constructs writers that write doclet specific output.
            </li>
            <li> 
                The doclet should have a taglet writer that extends
                {@link com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter}. 
                 This writer determines how to output each given tag.
            </li>
    </body>
</html>
jdk-sandbox