Package org.jdrupes.mdoclet

Klasse TreeConverter

java.lang.Object

org.jdrupes.mdoclet.TreeConverter

public class TreeConverter
extends Object

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TreeConverter(MarkdownProcessor processor, DocTreeFactory docTreeFactory, Elements elements)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<DocTree>	convertDescription(List<? extends DocTree> tree)	Converts a complete description.
List<DocTree>	convertFragment(List<? extends DocTree> tree)	Converts a fragment such as the description of a tag.
List<? extends DocTree>	convertSeeFragment(List<? extends DocTree> tree)	Converts a “see” tag.
void	convertTag(List<DocTree> target, AuthorTree tree)	Converts a AuthorTree.
void	convertTag(List<DocTree> target, DeprecatedTree tree)	Converts a DeprecatedTree.
void	convertTag(List<DocTree> target, DocTree tree)	Default conversion is a noop.
void	convertTag(List<DocTree> target, ParamTree tree)	Converts a ParamTree.
void	convertTag(List<DocTree> target, ReturnTree tree)	Converts a ReturnTree.
void	convertTag(List<DocTree> target, SeeTree tree)	Converts a SeeTree.
void	convertTag(List<DocTree> target, SinceTree tree)	Converts a SinceTree.
void	convertTag(List<DocTree> target, ThrowsTree tree)	Converts a ThrowsTree.
void	convertTag(List<DocTree> target, VersionTree tree)	Converts a VersionTree.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

TreeConverter

public TreeConverter(MarkdownProcessor processor,
 DocTreeFactory docTreeFactory,
 Elements elements)

Methodendetails

convertDescription

public List<DocTree> convertDescription(List<? extends DocTree> tree)

Converts a complete description.

Parameter:

tree - the tree to convert

Gibt zurück:

the result

convertFragment

public List<DocTree> convertFragment(List<? extends DocTree> tree)

Converts a fragment such as the description of a tag.

An attempt is made to remove any surrounding HTML tag added by the markdown processor.

Parameter:

tree - the tree to convert

Gibt zurück:

the result

convertSeeFragment

public List<? extends DocTree> convertSeeFragment(List<? extends DocTree> tree)

Converts a “see” tag.

The text is interpreted as markdown. If the result is a quoted link, only the link is returned.

Parameter:

tree - the tree to convert

Gibt zurück:

the result

convertTag

public void convertTag(List<DocTree> target,
 DocTree tree)

Default conversion is a noop.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 AuthorTree tree)

Converts a AuthorTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 DeprecatedTree tree)

Converts a DeprecatedTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 ParamTree tree)

Converts a ParamTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 ReturnTree tree)

Converts a ReturnTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 SeeTree tree)

Converts a SeeTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 SinceTree tree)

Converts a SinceTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 ThrowsTree tree)

Converts a ThrowsTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert

convertTag

public void convertTag(List<DocTree> target,
 VersionTree tree)

Converts a VersionTree.

See the overview for a description of the behavior.

Parameter:

target - the list to append the result to

tree - the tree to convert