Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse SourceToHTMLConverter

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.SourceToHTMLConverter

public class SourceToHTMLConverter
extends Object

Converts Java Source Code to HTML.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addStyleSheetProperties(Content head)	Returns a link to the stylesheet file.
protected void	addStylesheets(Content head)
void	convertClass(TypeElement te, DocPath outputdir)	Convert the given Class to an HTML.
void	convertModule(ModuleElement mdl, DocPath outputdir)	Convert the documented packages contained in the given module to an HTML representation.
void	convertPackage(PackageElement pkg, DocPath outputdir)	Convert the Classes in the given Package to an HTML file.
static void	convertRoot(HtmlConfiguration configuration, DocPath outputdir)	Translate the TypeElements in the given DocletEnvironment to HTML representation.
static HtmlId	getAnchorName(Utils utils, Element e)	Given an element, return an anchor name for it.

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

convertRoot

public static void convertRoot(HtmlConfiguration configuration,
 DocPath outputdir)
                        throws DocFileIOException,
SimpleDocletException

Translate the TypeElements in the given DocletEnvironment to HTML representation.

Parameter:

configuration - the configuration.

outputdir - the name of the directory to output to.

Löst aus:

DocFileIOException - if there is a problem generating an output file

SimpleDocletException - if there is a problem reading a source file

convertPackage

public void convertPackage(PackageElement pkg,
 DocPath outputdir)
                    throws DocFileIOException,
SimpleDocletException

Convert the Classes in the given Package to an HTML file.

Parameter:

pkg - the Package to convert.

outputdir - the name of the directory to output to.

Löst aus:

DocFileIOException - if there is a problem generating an output file

SimpleDocletException - if there is a problem reading a source file

convertModule

public void convertModule(ModuleElement mdl,
 DocPath outputdir)
                   throws DocFileIOException,
SimpleDocletException

Convert the documented packages contained in the given module to an HTML representation.

Parameter:

mdl - the module to convert.

outputdir - the name of the directory to output to.

Löst aus:

DocFileIOException - if there is a problem generating an output file

SimpleDocletException - if there is a problem reading a source file

convertClass

public void convertClass(TypeElement te,
 DocPath outputdir)
                  throws DocFileIOException,
SimpleDocletException

Convert the given Class to an HTML.

Parameter:

te - the class to convert.

outputdir - the name of the directory to output to

Löst aus:

DocFileIOException - if there is a problem generating the output file

SimpleDocletException - if there is a problem reading the source file

addStyleSheetProperties

public void addStyleSheetProperties(Content head)

Returns a link to the stylesheet file.

Parameter:

head - the content to which the stylesheet links will be added

addStylesheets

protected void addStylesheets(Content head)

getAnchorName

public static HtmlId getAnchorName(Utils utils,
 Element e)

Given an element, return an anchor name for it.

Parameter:

utils - the utility class, used to get the line number of the element

e - the element to check.

Gibt zurück:

the name of the anchor.