RootDoc (Java SE 11 & JDK 11 ) (original) (raw)
- All Superinterfaces:
[Comparable](../../../../java.base/java/lang/Comparable.html "interface in java.lang")<[Object](../../../../java.base/java/lang/Object.html "class in java.lang")>,[Doc](Doc.html "interface in com.sun.javadoc"),[DocErrorReporter](DocErrorReporter.html "interface in com.sun.javadoc")
@Deprecated(since="9",
forRemoval=true)
public interface RootDoc
extends Doc, DocErrorReporter
Deprecated, for removal: This API element is subject to removal in a future version.
Represents the root of the program structure information for one run of javadoc. From this root all other program structure information can be extracted. Also represents the command line information -- the packages, classes and options specified by the user.
Since:
1.2
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type Method Description ClassDoc[] classes() Deprecated, for removal: This API element is subject to removal in a future version. Return theincluded classes and interfaces in all packages. ClassDoc classNamed(String qualifiedName) Deprecated, for removal: This API element is subject to removal in a future version. Return a ClassDoc for the specified class or interface name. String[][] options() Deprecated, for removal: This API element is subject to removal in a future version. Command line options. PackageDoc packageNamed(String name) Deprecated, for removal: This API element is subject to removal in a future version. Return a PackageDoc for the specified package name. ClassDoc[] specifiedClasses() Deprecated, for removal: This API element is subject to removal in a future version. Return the classes and interfacesspecified as source file names on the command line. PackageDoc[] specifiedPackages() Deprecated, for removal: This API element is subject to removal in a future version. Return the packagesspecified on the command line. * ### Methods declared in interface com.sun.javadoc.[Doc](Doc.html "interface in com.sun.javadoc") `[commentText](Doc.html#commentText%28%29), [compareTo](Doc.html#compareTo%28java.lang.Object%29), [firstSentenceTags](Doc.html#firstSentenceTags%28%29), [getRawCommentText](Doc.html#getRawCommentText%28%29), [inlineTags](Doc.html#inlineTags%28%29), [isAnnotationType](Doc.html#isAnnotationType%28%29), [isAnnotationTypeElement](Doc.html#isAnnotationTypeElement%28%29), [isClass](Doc.html#isClass%28%29), [isConstructor](Doc.html#isConstructor%28%29), [isEnum](Doc.html#isEnum%28%29), [isEnumConstant](Doc.html#isEnumConstant%28%29), [isError](Doc.html#isError%28%29), [isException](Doc.html#isException%28%29), [isField](Doc.html#isField%28%29), [isIncluded](Doc.html#isIncluded%28%29), [isInterface](Doc.html#isInterface%28%29), [isMethod](Doc.html#isMethod%28%29), [isOrdinaryClass](Doc.html#isOrdinaryClass%28%29), [name](Doc.html#name%28%29), [position](Doc.html#position%28%29), [seeTags](Doc.html#seeTags%28%29), [setRawCommentText](Doc.html#setRawCommentText%28java.lang.String%29), [tags](Doc.html#tags%28%29), [tags](Doc.html#tags%28java.lang.String%29)` * ### Methods declared in interface com.sun.javadoc.[DocErrorReporter](DocErrorReporter.html "interface in com.sun.javadoc") `[printError](DocErrorReporter.html#printError%28com.sun.javadoc.SourcePosition,java.lang.String%29), [printError](DocErrorReporter.html#printError%28java.lang.String%29), [printNotice](DocErrorReporter.html#printNotice%28com.sun.javadoc.SourcePosition,java.lang.String%29), [printNotice](DocErrorReporter.html#printNotice%28java.lang.String%29), [printWarning](DocErrorReporter.html#printWarning%28com.sun.javadoc.SourcePosition,java.lang.String%29), [printWarning](DocErrorReporter.html#printWarning%28java.lang.String%29)`Method Detail
* #### options [String](../../../../java.base/java/lang/String.html "class in java.lang")[][] options() Deprecated, for removal: This API element is subject to removal in a future version. Command line options. For example, given: javadoc -foo this that -bar other ... this method will return: options()[0][0] = "-foo" options()[0][1] = "this" options()[0][2] = "that" options()[1][0] = "-bar" options()[1][1] = "other" Returns: an array of arrays of String. * #### specifiedPackages [PackageDoc](PackageDoc.html "interface in com.sun.javadoc")[] specifiedPackages() Deprecated, for removal: This API element is subject to removal in a future version. Return the packages[specified](package-summary.html#included) on the command line. If `-subpackages` and `-exclude` options are used, return all the non-excluded packages. Returns: packages specified on the command line. * #### specifiedClasses [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] specifiedClasses() Deprecated, for removal: This API element is subject to removal in a future version. Return the classes and interfaces[specified](package-summary.html#included) as source file names on the command line. Returns: classes and interfaces specified on the command line. * #### classes [ClassDoc](ClassDoc.html "interface in com.sun.javadoc")[] classes() Deprecated, for removal: This API element is subject to removal in a future version. Return the[included](package-summary.html#included) classes and interfaces in all packages. Returns: included classes and interfaces in all packages. * #### packageNamed [PackageDoc](PackageDoc.html "interface in com.sun.javadoc") packageNamed([String](../../../../java.base/java/lang/String.html "class in java.lang") name) Deprecated, for removal: This API element is subject to removal in a future version. Return a PackageDoc for the specified package name. Parameters: `name` \- package name Returns: a PackageDoc holding the specified package, null if this package is not referenced. * #### classNamed [ClassDoc](ClassDoc.html "interface in com.sun.javadoc") classNamed([String](../../../../java.base/java/lang/String.html "class in java.lang") qualifiedName) Deprecated, for removal: This API element is subject to removal in a future version. Return a ClassDoc for the specified class or interface name. Parameters: `qualifiedName` \- [qualified](package-summary.html#qualified) class or package name Returns: a ClassDoc holding the specified class, null if this class is not referenced.
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2025, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.