A C D E F G H I L M O P R S T W

A

Annotations - Class in de.unkrig.commons.doclet

Utility methods related to doclets and annotations.

C

className(ClassDoc) - Static method in class de.unkrig.commons.doclet.Types

classNamed(RootDoc, String) - Static method in class de.unkrig.commons.doclet.Docs

A drop-in replacement for RootDoc.classNamed(String), but instead of returning null it prints an error and throws a Longjump.

classScope(Doc) - Static method in class de.unkrig.commons.doclet.Docs

D

de.unkrig.commons.doclet - package de.unkrig.commons.doclet

Functionality that is related to ORACLE's DOCLET API.

de.unkrig.commons.doclet.html - package de.unkrig.commons.doclet.html

Functionality that is related to the generation of HTML documentation from a doclet.

defaultLabelHtml - Variable in class de.unkrig.commons.doclet.html.Html.Link

The "default label" for the link; typically it not only depends on the link target, but also on the link source.

Docs - Class in de.unkrig.commons.doclet

Utility methods related to doclet tags.

DOCS_BY_NAME_COMPARATOR - Static variable in class de.unkrig.commons.doclet.Docs

Compares Docs by their name.

E

escapeSgmlEntities(String) - Static method in class de.unkrig.commons.doclet.html.Html

Replaces "<", ">" and "&".

expandTag(Doc, RootDoc, Tag) - Method in class de.unkrig.commons.doclet.html.Html

Expands a tag to HTML text.

ExternalJavadocsLinkMaker(Map<String, URL>, Html.LinkMaker) - Constructor for class de.unkrig.commons.doclet.html.Html.ExternalJavadocsLinkMaker

F

findDoc(Doc, String, RootDoc) - Static method in class de.unkrig.commons.doclet.Docs

fromTags(Tag[], Doc, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html

Expands inline tags to HTML.

G

generateFor(Doc, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html

Generates HTML markup for the given doc in the context of ref.

get(ProgramElementDoc, String) - Static method in class de.unkrig.commons.doclet.Annotations

get(ProgramElementDoc, ClassDoc) - Static method in class de.unkrig.commons.doclet.Annotations

get(ProgramElementDoc, Class<?>, RootDoc) - Static method in class de.unkrig.commons.doclet.Annotations

getAnnotationElementValue(AnnotationDesc, String) - Static method in class de.unkrig.commons.doclet.Annotations

Determines and returns the value of the named element.

getAnnotationValue(AnnotationValue) - Static method in class de.unkrig.commons.doclet.Annotations

Determines and returns the value of an AnnotationValue.

getElementValue(AnnotationDesc, String, Class<T>) - Static method in class de.unkrig.commons.doclet.Annotations

H

href - Variable in class de.unkrig.commons.doclet.html.Html.Link

null if the bare label should be displayed instead of a link

hrefToDoc(String, RootDoc, ClassDoc) - Static method in class de.unkrig.commons.doclet.html.Html

Html - Class in de.unkrig.commons.doclet.html

Helper functionality in the context of doclets and HTML.

Html(Html.LinkMaker) - Constructor for class de.unkrig.commons.doclet.html.Html

Html.ExternalJavadocsLinkMaker - Class in de.unkrig.commons.doclet.html

See the documentation of the '-linkoffline' option of the JAVADOC tool.

Html.Link - Class in de.unkrig.commons.doclet.html

Representation of a link in an HTML document.

Html.LinkMaker - Interface in de.unkrig.commons.doclet.html

When generating HTML from JAVADOC, this interface is used to generate links to JAVA elements.

I

isSubclassOf(ClassDoc, ClassDoc) - Static method in class de.unkrig.commons.doclet.Docs

L

Link(String, String) - Constructor for class de.unkrig.commons.doclet.html.Html.Link

loadType(SourcePosition, Type, DocErrorReporter) - Static method in class de.unkrig.commons.doclet.Types

M

makeLink(Doc, Doc, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html.ExternalJavadocsLinkMaker

makeLink(Doc, Doc, RootDoc) - Method in interface de.unkrig.commons.doclet.html.Html.LinkMaker

Generates a Html.Link that refers from the HTML page on which from is described to the HTML page (and possibly the anchor) that describes to.

makeLink(Doc, Doc, boolean, String, String, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html

methods(ClassDoc, boolean, boolean) - Static method in class de.unkrig.commons.doclet.Docs

An enhanced version of ClassDoc.methods(boolean) which optionally also includes inherited methods.

O

optionalTag(Doc, String, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html

Verifies that the named block tag exists at most once, replaces line breaks with spaces, and convert its text to HTML.

optionalTag(Doc, String, DocErrorReporter) - Static method in class de.unkrig.commons.doclet.Tags

Verifies that the named block tag exists at most once, and returns it.

P

packageScope(Doc) - Static method in class de.unkrig.commons.doclet.Docs

R

readExternalJavadocs(URL, URL, Map<String, URL>, RootDoc) - Static method in class de.unkrig.commons.doclet.Docs

Reads package names from "packageListUrl/package-list" and puts them into the externalJavadocs map.

requiredTag(Doc, String, DocErrorReporter) - Static method in class de.unkrig.commons.doclet.Tags

Verifies that the named block tag exists exactly once, and returns it.

S

STANDARD_LINK_MAKER - Static variable in class de.unkrig.commons.doclet.html.Html

Implements the strategy of the standard JAVADOC doclet.

summaryDescription(Doc, RootDoc) - Method in class de.unkrig.commons.doclet.html.Html

T

Tags - Class in de.unkrig.commons.doclet

Utility methods related to doclet tags.

targetOfSeeTag(SeeTag) - Static method in class de.unkrig.commons.doclet.html.Html

TYPE_COMPARATOR - Static variable in class de.unkrig.commons.doclet.Docs

Compares two Types.

Types - Class in de.unkrig.commons.doclet

Helper functionality related to doclet Types.

W

withSuperclasses(ClassDoc) - Static method in class de.unkrig.commons.doclet.Docs

withSuperclassesAndInterfaces(ClassDoc) - Static method in class de.unkrig.commons.doclet.Docs

A C D E F G H I L M O P R S T W