1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java Wed Apr 27 01:34:52 2016 +0800
1.3 @@ -0,0 +1,52 @@
1.4 +/*
1.5 + * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +/**
1.30 + This package has classes used to generate Javadoc tag documentation.
1.31 + Doclets no longer have to implement its own version of standard tags
1.32 + such as @param and @throws. This is the single, doclet
1.33 + implementation of each standard tag that is shared by all
1.34 + doclets. Each doclet must have a taglet writer that takes a taglet
1.35 + as input and writes doclet-dependent output. The taglet itself will
1.36 + do the tag processing. For example, suppose we are outputing
1.37 + @throws tags. The taglet would:
1.38 + <ul>
1.39 + <li> Retrieve the list of throws tags to be documented.
1.40 + <li> Replace {@inheritDoc} with the appropriate documentation.
1.41 + <li> Add throws documentation for exceptions that are declared in
1.42 + the signature of the method but
1.43 + not documented with the throws tags.
1.44 + </ul>
1.45 + After doing the steps above, the taglet would pass the information to
1.46 + the taglet writer for writing. The taglets are essentially builders for
1.47 + tags.
1.48 +
1.49 + <p><b>This is NOT part of any supported API.
1.50 + If you write code that depends on this, you do so at your own risk.
1.51 + This code and its internal interfaces are subject to change or
1.52 + deletion without notice.</b>
1.53 +*/
1.54 +@jdk.Exported(false)
1.55 +package com.sun.tools.doclets.internal.toolkit.taglets;
