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
Html.Link	makeLink(com.sun.javadoc.Doc from, com.sun.javadoc.Doc to, com.sun.javadoc.RootDoc rootDoc) 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.

Method Detail

makeLink

Html.Link makeLink(com.sun.javadoc.Doc from,
                   com.sun.javadoc.Doc to,
                   com.sun.javadoc.RootDoc rootDoc)
            throws Longjump

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.

Throws:

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