133 * <p> |
133 * <p> |
134 * <a id="legacy-interactions"></a> |
134 * <a id="legacy-interactions"></a> |
135 * <h4>Interactions with older options.</h4> |
135 * <h4>Interactions with older options.</h4> |
136 * |
136 * |
137 * The new {@code --show-*} options provide a more detailed replacement |
137 * The new {@code --show-*} options provide a more detailed replacement |
138 * for the older options -public, -protected, -package, -private. |
138 * for the older options {@code -public}, {@code -protected}, {@code -package}, {@code -private}. |
139 * Alternatively, the older options can continue to be used as shorter |
139 * Alternatively, the older options can continue to be used as shorter |
140 * forms for combinations of the new options, as described below: |
140 * forms for combinations of the new options, as described below: |
141 <table style="font-family: monospace" border=1> |
141 * <table class="striped"> |
142 <caption>Short form options mapping</caption> |
142 * <caption>Short form options mapping</caption> |
143 <tr><th>Older option<th colspan="5">Equivalent to these values with the new option |
143 * <thead> |
144 <tr><th><th>{@code --show-members}<th>{@code --show-types}<th>{@code --show-packages}<th>{@code --show-module-contents} |
144 * <tr> <th rowspan="2" scope="col" style="vertical-align:top"> |
145 <tr><td>{@code -public}<td>public<td>public<td>exported<td>api |
145 * Older option |
146 <tr><td>{@code -protected}<td>protected<td>protected<td>exported<td>api |
146 * <th colspan="5" scope="col" style="border-bottom: 1px solid black"> |
147 <tr><td>{@code -package}<td>package<td>package<td>all<td>all |
147 * Equivalent to these values with the new option |
148 <tr><td>{@code -private}<td>private<td>private<td>all<td>all |
148 * <tr> <th scope="col">{@code --show-members} |
149 </table> |
149 * <th scope="col">{@code --show-types} |
|
150 * <th scope="col">{@code --show-packages} |
|
151 * <th scope="col">{@code --show-module-contents} |
|
152 * </thead> |
|
153 * <tbody> |
|
154 * <tr> <th scope="row">{@code -public} |
|
155 * <td>public |
|
156 * <td>public |
|
157 * <td>exported |
|
158 * <td>api |
|
159 * <tr> <th scope="row">{@code -protected} |
|
160 * <td>protected |
|
161 * <td>protected |
|
162 * <td>exported |
|
163 * <td>api |
|
164 * <tr> <th scope="row">{@code -package} |
|
165 * <td>package |
|
166 * <td>package |
|
167 * <td>all |
|
168 * <td>all |
|
169 * <tr> <th scope="row">{@code -private} |
|
170 * <td>private |
|
171 * <td>private |
|
172 * <td>all |
|
173 * <td>all |
|
174 * </tbody> |
|
175 * </table> |
150 * <p> |
176 * <p> |
151 * <a id="qualified"></a> |
177 * <a id="qualified"></a> |
152 * A <em>qualified</em> element name is one that has its package |
178 * A <em>qualified</em> element name is one that has its package |
153 * name prepended to it, such as {@code java.lang.String}. A non-qualified |
179 * name prepended to it, such as {@code java.lang.String}. A non-qualified |
154 * name has no package name, such as {@code String}. |
180 * name has no package name, such as {@code String}. |
281 * are used instead. |
307 * are used instead. |
282 * |
308 * |
283 * <p>The following table gives a guide to the mapping from old types to their replacements. |
309 * <p>The following table gives a guide to the mapping from old types to their replacements. |
284 * In some cases, there is no direct equivalent. |
310 * In some cases, there is no direct equivalent. |
285 * |
311 * |
286 * <table style="font-family: monospace" border=1> |
312 * <table class="striped"> |
287 <caption>Guide for mapping old types to new types</caption> |
313 * <caption>Guide for mapping old types to new types</caption> |
288 <tr><th>Old Type<th>New Type |
314 * <thead> |
289 <tr><td>AnnotatedType<td>javax.lang.model.type.Type |
315 * <tr><th scope="col">Old Type<th scope="col">New Type |
290 <tr><td>AnnotationDesc<td>javax.lang.model.element.AnnotationMirror |
316 * </thead> |
291 <tr><td>AnnotationDesc.ElementValuePair<td>javax.lang.model.element.AnnotationValue |
317 * <tbody style="text-align:left"> |
292 <tr><td>AnnotationTypeDoc<td>javax.lang.model.element.TypeElement |
318 * <tr><th scope="row">{@code AnnotatedType} <td>{@link javax.lang.model.type.TypeMirror javax.lang.model.type.TypeMirror} |
293 <tr><td>AnnotationTypeElementDoc<td>javax.lang.model.element.ExecutableElement |
319 * <tr><th scope="row">{@code AnnotationDesc} <td>{@link javax.lang.model.element.AnnotationMirror javax.lang.model.element.AnnotationMirror} |
294 <tr><td>AnnotationValue<td>javax.lang.model.element.AnnotationValue |
320 * <tr><th scope="row">{@code AnnotationDesc.ElementValuePair}<td>{@link javax.lang.model.element.AnnotationValue javax.lang.model.element.AnnotationValue} |
295 <tr><td>ClassDoc<td>javax.lang.model.element.TypeElement |
321 * <tr><th scope="row">{@code AnnotationTypeDoc} <td>{@link javax.lang.model.element.TypeElement javax.lang.model.element.TypeElement} |
296 <tr><td>ConstructorDoc<td>javax.lang.model.element.ExecutableElement |
322 * <tr><th scope="row">{@code AnnotationTypeElementDoc} <td>{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement} |
297 <tr><td>Doc<td>javax.lang.model.element.Element |
323 * <tr><th scope="row">{@code AnnotationValue} <td>{@link javax.lang.model.element.AnnotationValue javax.lang.model.element.AnnotationValue} |
298 <tr><td>DocErrorReporter<td>jdk.javadoc.doclet.Reporter |
324 * <tr><th scope="row">{@code ClassDoc} <td>{@link javax.lang.model.element.TypeElement javax.lang.model.element.TypeElement} |
299 <tr><td>Doclet<td>jdk.javadoc.doclet.Doclet |
325 * <tr><th scope="row">{@code ConstructorDoc} <td>{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement} |
300 <tr><td>ExecutableMemberDoc<td>javax.lang.model.element.ExecutableElement |
326 * <tr><th scope="row">{@code Doc} <td>{@link javax.lang.model.element.Element javax.lang.model.element.Element} |
301 <tr><td>FieldDoc<td>javax.lang.model.element.VariableElement |
327 * <tr><th scope="row">{@code DocErrorReporter} <td>{@link jdk.javadoc.doclet.Reporter jdk.javadoc.doclet.Reporter} |
302 <tr><td>LanguageVersion<td>javax.lang.model.SourceVersion |
328 * <tr><th scope="row">{@code Doclet} <td>{@link jdk.javadoc.doclet.Doclet jdk.javadoc.doclet.Doclet} |
303 <tr><td>MemberDoc<td>javax.lang.model.element.Element |
329 * <tr><th scope="row">{@code ExecutableMemberDoc} <td>{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement} |
304 <tr><td>MethodDoc<td>javax.lang.model.element.ExecutableElement |
330 * <tr><th scope="row">{@code FieldDoc} <td>{@link javax.lang.model.element.VariableElement javax.lang.model.element.VariableElement} |
305 <tr><td>PackageDoc<td>javax.lang.model.element.PackageElement |
331 * <tr><th scope="row">{@code LanguageVersion} <td>{@link javax.lang.model.SourceVersion javax.lang.model.SourceVersion} |
306 <tr><td>Parameter<td>javax.lang.model.element.VariableElement |
332 * <tr><th scope="row">{@code MemberDoc} <td>{@link javax.lang.model.element.Element javax.lang.model.element.Element} |
307 <tr><td>ParameterizedType<td>javax.lang.model.type.DeclaredType |
333 * <tr><th scope="row">{@code MethodDoc} <td>{@link javax.lang.model.element.ExecutableElement javax.lang.model.element.ExecutableElement} |
308 <tr><td>ParamTag<td>com.sun.source.doctree.ParamTree |
334 * <tr><th scope="row">{@code PackageDoc} <td>{@link javax.lang.model.element.PackageElement javax.lang.model.element.PackageElement} |
309 <tr><td>ProgramElementDoc<td>javax.lang.model.element.Element |
335 * <tr><th scope="row">{@code Parameter} <td>{@link javax.lang.model.element.VariableElement javax.lang.model.element.VariableElement} |
310 <tr><td>RootDoc<td>jdk.javadoc.doclet.DocletEnvironment |
336 * <tr><th scope="row">{@code ParameterizedType} <td>{@link javax.lang.model.type.DeclaredType javax.lang.model.type.DeclaredType} |
311 <tr><td>SeeTag<td>com.sun.source.doctree.LinkTree<br>com.sun.source.doctree.SeeTree |
337 * <tr><th scope="row">{@code ParamTag} <td>{@link com.sun.source.doctree.ParamTree com.sun.source.doctree.ParamTree} |
312 <tr><td>SerialFieldTag<td>com.sun.source.doctree.SerialFieldTree |
338 * <tr><th scope="row">{@code ProgramElementDoc} <td>{@link javax.lang.model.element.Element javax.lang.model.element.Element} |
313 <tr><td>SourcePosition<td>com.sun.source.util.SourcePositions |
339 * <tr><th scope="row">{@code RootDoc} <td>{@link jdk.javadoc.doclet.DocletEnvironment jdk.javadoc.doclet.DocletEnvironment} |
314 <tr><td>Tag<td>com.sun.source.doctree.DocTree |
340 * <tr><th scope="row">{@code SeeTag} <td>{@link com.sun.source.doctree.LinkTree com.sun.source.doctree.LinkTree}<br> |
315 <tr><td>ThrowsTag<td>com.sun.source.doctree.ThrowsTree |
341 * {@link com.sun.source.doctree.SeeTree com.sun.source.doctree.SeeTree} |
316 <tr><td>Type<td>javax.lang.model.type.Type |
342 * <tr><th scope="row">{@code SerialFieldTag} <td>{@link com.sun.source.doctree.SerialFieldTree com.sun.source.doctree.SerialFieldTree} |
317 <tr><td>TypeVariable<td>javax.lang.model.type.TypeVariable |
343 * <tr><th scope="row">{@code SourcePosition} <td>{@link com.sun.source.util.SourcePositions com.sun.source.util.SourcePositions} |
318 <tr><td>WildcardType<td>javax.lang.model.type.WildcardType |
344 * <tr><th scope="row">{@code Tag} <td>{@link com.sun.source.doctree.DocTree com.sun.source.doctree.DocTree} |
|
345 * <tr><th scope="row">{@code ThrowsTag} <td>{@link com.sun.source.doctree.ThrowsTree com.sun.source.doctree.ThrowsTree} |
|
346 * <tr><th scope="row">{@code Type} <td>{@link javax.lang.model.type.TypeMirror javax.lang.model.type.TypeMirror} |
|
347 * <tr><th scope="row">{@code TypeVariable} <td>{@link javax.lang.model.type.TypeVariable javax.lang.model.type.TypeVariable} |
|
348 * <tr><th scope="row">{@code WildcardType} <td>{@link javax.lang.model.type.WildcardType javax.lang.model.type.WildcardType} |
|
349 * </tbody> |
319 * </table> |
350 * </table> |
320 * |
351 * |
321 * @see jdk.javadoc.doclet.Doclet |
352 * @see jdk.javadoc.doclet.Doclet |
322 * @see jdk.javadoc.doclet.DocletEnvironment |
353 * @see jdk.javadoc.doclet.DocletEnvironment |
323 * @since 9 |
354 * @since 9 |