Package org.jdrupes.mdoclet.internal.doclets.toolkit

Klasse OverviewElement

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.OverviewElement

Alle implementierten Schnittstellen:

AnnotatedConstruct, Element, DocletElement

public class OverviewElement
extends Object
implements DocletElement

This is a pseudo element wrapper for the overview element, essentially to associate overview documentation’s DocCommentTree to this element.

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.DocletElement

DocletElement.Kind

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
OverviewElement(PackageElement pkg, FileObject fo)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
FileObject	getFileObject()	Returns the file object associated with this special element such as overview.html, doc-files/foo.html.
PackageElement	getPackageElement()	Returns the anchoring package element, in the case of a module element, this is the module’s unnamed package.
DocletElement.Kind	getSubKind()	Returns the subkind of this element.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.DocletElement

accept, asType, getAnnotation, getAnnotationMirrors, getAnnotationsByType, getEnclosedElements, getEnclosingElement, getKind, getModifiers, getSimpleName

Von Schnittstelle geerbte Methoden javax.lang.model.element.Element

equals, hashCode

Konstruktordetails

OverviewElement

public OverviewElement(PackageElement pkg,
 FileObject fo)

Methodendetails

getPackageElement

public PackageElement getPackageElement()

Beschreibung aus Schnittstelle kopiert: DocletElement

Returns the anchoring package element, in the case of a module element, this is the module’s unnamed package.

Angegeben von:

getPackageElement in Schnittstelle DocletElement

Gibt zurück:

the anchor element.

getFileObject

public FileObject getFileObject()

Beschreibung aus Schnittstelle kopiert: DocletElement

Returns the file object associated with this special element such as overview.html, doc-files/foo.html.

Angegeben von:

getFileObject in Schnittstelle DocletElement

Gibt zurück:

the file object

getSubKind

public DocletElement.Kind getSubKind()

Beschreibung aus Schnittstelle kopiert: DocletElement

Returns the subkind of this element.

Angegeben von:

getSubKind in Schnittstelle DocletElement

Gibt zurück:

a subkind