de.unkrig.commons.doclet.html

Interface Html.LinkMaker

All Known Implementing Classes:

Html.ExternalJavadocsLinkMaker

Enclosing class:

Html

public static interface Html.LinkMaker

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	makeDefaultLabel(com.sun.javadoc.Doc from, com.sun.javadoc.Doc to, com.sun.javadoc.RootDoc rootDoc) Generates the "default label" for the link that refers from the HTML page on which from is described to the place where to is described.
java.lang.String	makeHref(com.sun.javadoc.Doc from, com.sun.javadoc.Doc to, com.sun.javadoc.RootDoc rootDoc) Generates an "href" that refers from the HTML page on which from is described to the HTML page (and possibly the anchor) that describes to.

Method Detail

makeHref

@Nullable
java.lang.String makeHref(com.sun.javadoc.Doc from,
                                     com.sun.javadoc.Doc to,
                                     com.sun.javadoc.RootDoc rootDoc)
                              throws Longjump

Generates an "href" that refers from the HTML page on which from is described to the HTML page (and possibly the anchor) that describes to.

Returns:

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

Throws:

Longjump - A link href could be determined, but for some reason it was forbidden to link there

makeDefaultLabel

java.lang.String makeDefaultLabel(com.sun.javadoc.Doc from,
                                  com.sun.javadoc.Doc to,
                                  com.sun.javadoc.RootDoc rootDoc)
                           throws Longjump

Generates the "default label" for the link that refers from the HTML page on which from is described to the place where to is described.

Throws:

Longjump