aoqi@0: /*
aoqi@0:  * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: /**
aoqi@0:     This package has classes used to generate Javadoc tag documentation.
aoqi@0:     Doclets no longer have to implement its own version of standard tags
aoqi@0:     such as @param and @throws.  This is the single, doclet
aoqi@0:     implementation of each standard tag that is shared by all
aoqi@0:     doclets.  Each doclet must have a taglet writer that takes a taglet
aoqi@0:     as input and writes doclet-dependent output. The taglet itself will
aoqi@0:     do the tag processing. For example, suppose we are outputing
aoqi@0:     @throws tags. The taglet would:
aoqi@0:     <ul>
aoqi@0:         <li> Retrieve the list of throws tags to be documented.
aoqi@0:         <li> Replace {&#64;inheritDoc} with the appropriate documentation.
aoqi@0:         <li> Add throws documentation for exceptions that are declared in
aoqi@0:              the signature of the method but
aoqi@0:              not documented with the throws tags.
aoqi@0:     </ul>
aoqi@0:     After doing the steps above, the taglet would pass the information to
aoqi@0:     the taglet writer for writing. The taglets are essentially builders for
aoqi@0:     tags.
aoqi@0: 
aoqi@0:     <p><b>This is NOT part of any supported API.
aoqi@0:     If you write code that depends on this, you do so at your own risk.
aoqi@0:     This code and its internal interfaces are subject to change or
aoqi@0:     deletion without notice.</b>
aoqi@0: */
aoqi@0: @jdk.Exported(false)
aoqi@0: package com.sun.tools.doclets.internal.toolkit.taglets;