1 /*

     2  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     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.

    10  *

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

    16  *

    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.

    20  *

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

    25 

    26 /**

    27     Contains the base classes that make up a doclet.  Doclets that reuse

    28     the functionality provided by the toolkit should have the following

    29     characteristics:

    30     <ul>

    31         <li>

    32             The main driver class should extend

    33             {@link com.sun.tools.doclets.internal.toolkit.AbstractDoclet}.

    34         </li>

    35         <li>

    36             The doclet configuration class should extend

    37             {@link com.sun.tools.doclets.internal.toolkit.Configuration}.

    38         </li>

    39         <li>

    40             The doclet should have a writer factory that implements

    41             {@link com.sun.tools.doclets.internal.toolkit.WriterFactory}.

    42             This class constructs writers that write doclet specific output.

    43         </li>

    44         <li>

    45             The doclet should have a taglet writer that extends

    46             {@link com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter}.

    47              This writer determines how to output each given tag.

    48         </li>

    49     </ul>

    50 

    51     <p><b>This is NOT part of any supported API.

    52     If you write code that depends on this, you do so at your own risk.

    53     This code and its internal interfaces are subject to change or

    54     deletion without notice.</b>

    55 */

    56 @jdk.Exported(false)

    57 package com.sun.tools.doclets.internal.toolkit;