src/share/classes/com/sun/tools/doclets/internal/toolkit/package.html

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 554
9d9f26857129
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

     1 <!--
     2  Copyright (c) 2003, Oracle and/or its affiliates. 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.  Oracle designates this
     8  particular file as subject to the "Classpath" exception as provided
     9  by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    22  or visit www.oracle.com if you need additional information or have any
    23  questions.
    24 -->
    26 <html>
    27 <head>
    28 <title>com.sun.tools.doclets.internal.toolkit package</title>
    29 </head>
    30 <body bgcolor="white">
    32         Contains the base classes that make up a doclet.  Doclets that reuse
    33         the functionality provided by the toolkit should have the following
    34         characteristics:
    35         <ul>
    36             <li> 
    37                 The main driver class should extend 
    38                 {@link com.sun.tools.doclets.internal.toolkit.AbstractDoclet}.
    39             </li>
    40             <li> 
    41                 The doclet configuration class should extend 
    42                 {@link com.sun.tools.doclets.internal.toolkit.Configuration}.
    43             </li>
    44             <li> 
    45                 The doclet should have a writer factory that implements
    46                 {@link com.sun.tools.doclets.internal.toolkit.WriterFactory}.  
    47                 This class constructs writers that write doclet specific output.
    48             </li>
    49             <li> 
    50                 The doclet should have a taglet writer that extends
    51                 {@link com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter}. 
    52                  This writer determines how to output each given tag.
    53             </li>
    54     </body>
    55 </html>

mercurial