Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/package-info.java
- changeset 0
- 959103a6100f
- child 2525
- 2eb010b6cb22
equal
deleted
inserted
replaced
| -1:000000000000 | 0:959103a6100f |
|---|---|
| 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 This package has classes used to generate Javadoc tag documentation. | |
| 28 Doclets no longer have to implement its own version of standard tags | |
| 29 such as @param and @throws. This is the single, doclet | |
| 30 implementation of each standard tag that is shared by all | |
| 31 doclets. Each doclet must have a taglet writer that takes a taglet | |
| 32 as input and writes doclet-dependent output. The taglet itself will | |
| 33 do the tag processing. For example, suppose we are outputing | |
| 34 @throws tags. The taglet would: | |
| 35 <ul> | |
| 36 <li> Retrieve the list of throws tags to be documented. | |
| 37 <li> Replace {@inheritDoc} with the appropriate documentation. | |
| 38 <li> Add throws documentation for exceptions that are declared in | |
| 39 the signature of the method but | |
| 40 not documented with the throws tags. | |
| 41 </ul> | |
| 42 After doing the steps above, the taglet would pass the information to | |
| 43 the taglet writer for writing. The taglets are essentially builders for | |
| 44 tags. | |
| 45 | |
| 46 <p><b>This is NOT part of any supported API. | |
| 47 If you write code that depends on this, you do so at your own risk. | |
| 48 This code and its internal interfaces are subject to change or | |
| 49 deletion without notice.</b> | |
| 50 */ | |
| 51 @jdk.Exported(false) | |
| 52 package com.sun.tools.doclets.internal.toolkit.taglets; |
