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