de.unkrig.commons.doclet.html

Class Html.ExternalJavadocsLinkMaker

java.lang.Object

de.unkrig.commons.doclet.html.Html.ExternalJavadocsLinkMaker

All Implemented Interfaces:

Html.LinkMaker

Enclosing class:

Html

public static final class Html.ExternalJavadocsLinkMaker
extends Object
implements Html.LinkMaker

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

Constructor Summary

Constructors

Constructor and Description
ExternalJavadocsLinkMaker(Map<String,URL> externalJavadocs, Html.LinkMaker delegate)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalJavadocsLinkMaker

public ExternalJavadocsLinkMaker(Map<String,URL> externalJavadocs,
                                 Html.LinkMaker delegate)

Method Detail

makeLink

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

Description copied from interface: 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.

Specified by:

makeLink in interface Html.LinkMaker

Throws:

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