ball.tools.javadoc

Interface JavadocHTMLTemplates

All Superinterfaces:

HTMLTemplates, XMLServices

All Known Subinterfaces:

SunToolsInternalToolkitTaglet

All Known Implementing Classes:

AbstractInlineTaglet, AbstractTaglet, AntTaskTaglet, BeanInfoTaglet, IncludeTaglet, InjectedFieldsTaglet, LinkManTaglet, LinkRFCTaglet, LinkThisTaglet, LinkURITaglet, MavenBootstrapTaglet, MavenTaglet, MavenTaglet.Coordinates, MavenTaglet.PluginFields, MavenTaglet.PluginHelp

public interface JavadocHTMLTemplates
extends HTMLTemplates

Javadoc HTMLTemplates.

Version:

$Revision: 6035 $

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method and Description
default FluentNode	a(Tag tag, Class<?> type) <a href="type">ClassDoc.name()</a>
FluentNode	a(Tag tag, Class<?> type, Node node)
default FluentNode	a(Tag tag, Class<?> type, String name) <a href="type">code(name)</a>
default FluentNode	a(Tag tag, Enum<?> constant) <a href="constant">constant.name()</a>
default FluentNode	a(Tag tag, Member member) <a href="member">MemberDoc.name()</a>
FluentNode	a(Tag tag, Member member, Node node)
default FluentNode	a(Tag tag, Member member, String name) <a href="member">code(name)</a>
FluentNode	a(Tag tag, ProgramElementDoc target, Node node)
FluentNode	a(Tag tag, String name, Node node)
default FluentNode	annotation(Tag tag, Annotation annotation) <a href="annotation">code(String.valueOf(annotation))</a>
default FluentNode	declaration(Tag tag, Field field) Method to generate a Field declaration with javadoc hyperlinks.
default FluentNode	declaration(Tag tag, Member member) Dispatches call to declaration(Tag,Field) or declaration(Tag,Method) as appropriate.
default FluentNode	declaration(Tag tag, Method method) Method to generate a Method declaration with javadoc hyperlinks.
default FluentNode	declaration(Tag tag, Parameter parameter) Method to generate a Parameter declaration with javadoc hyperlinks.
default FluentNode	modifiers(int modifiers) Method to generate modifiers for declaration() methods.
default FluentNode	table(Tag tag, TableModel model, Node... nodes) <table>model</table>
default FluentNode	table(Tag tag, TableModel model, Stream<Node> stream) <table>model</table>
default FluentNode	toHTML(Tag tag, Object object) Method to get a Javadoc HTML representation of an Object.
default FluentNode	type(Tag tag, Type type) Method to generate types for declaration() methods.
default FluentNode	warning(Tag tag, Throwable throwable) <p><b><u>tag</u></b></p> <!-- stack trace-->

Methods inherited from interface ball.xml.HTMLTemplates

a, a, a, b, b, caption, code, code, div, div, h1, h1, h1, h2, h2, h2, h3, h3, h3, h4, h4, h4, h5, h5, h5, h6, h6, h6, li, li, li, ol, ol, p, p, p, pre, pre, table, table, tbody, tbody, td, td, tfoot, tfoot, th, th, thead, thead, tr, tr, u, u, ul, ul

Methods inherited from interface ball.xml.XMLServices

asStream, attr, attr, cdata, comment, document, element, element, fragment, fragment, text

Method Detail

a

FluentNode a(Tag tag,
             ProgramElementDoc target,
             Node node)

a

FluentNode a(Tag tag,
             Class<?> type,
             Node node)

a

FluentNode a(Tag tag,
             Member member,
             Node node)

a

FluentNode a(Tag tag,
             String name,
             Node node)

warning

default FluentNode warning(Tag tag,
                           Throwable throwable)

<p><b><u>tag</u></b></p> <!-- stack trace-->

Parameters:

tag - The offending Tag.

throwable - The Throwable.

Returns:

DocumentFragment

a

default FluentNode a(Tag tag,
                     Class<?> type)

<a href="type">ClassDoc.name()</a>

Parameters:

tag - The Tag.

type - The target Class.

Returns:

Element

a

default FluentNode a(Tag tag,
                     Class<?> type,
                     String name)

<a href="type">code(name)</a>

Parameters:

tag - The Tag.

type - The target Class.

name - The link name.

Returns:

Element

a

default FluentNode a(Tag tag,
                     Member member)

<a href="member">MemberDoc.name()</a>

Parameters:

tag - The Tag.

member - The target Member.

Returns:

Element

a

default FluentNode a(Tag tag,
                     Member member,
                     String name)

<a href="member">code(name)</a>

Parameters:

tag - The Tag.

member - The target Member.

name - The link name.

Returns:

Element

a

default FluentNode a(Tag tag,
                     Enum<?> constant)

<a href="constant">constant.name()</a>

Parameters:

tag - The Tag.

constant - The target Enum.

Returns:

Element

declaration

default FluentNode declaration(Tag tag,
                               Member member)

Dispatches call to declaration(Tag,Field) or declaration(Tag,Method) as appropriate.

Parameters:

tag - The Tag.

member - The target Member.

Returns:

DocumentFragment

declaration

default FluentNode declaration(Tag tag,
                               Field field)

Method to generate a Field declaration with javadoc hyperlinks.

Parameters:

tag - The Tag.

field - The target Field.

Returns:

DocumentFragment

declaration

default FluentNode declaration(Tag tag,
                               Method method)

Method to generate a Method declaration with javadoc hyperlinks.

Parameters:

tag - The Tag.

method - The target Method.

Returns:

DocumentFragment

declaration

default FluentNode declaration(Tag tag,
                               Parameter parameter)

Method to generate a Parameter declaration with javadoc hyperlinks.

Parameters:

tag - The Tag.

parameter - The target Parameter.

Returns:

DocumentFragment

annotation

default FluentNode annotation(Tag tag,
                              Annotation annotation)

<a href="annotation">code(String.valueOf(annotation))</a>

Parameters:

tag - The Tag.

annotation - The target Annotation.

Returns:

Element

modifiers

default FluentNode modifiers(int modifiers)

Method to generate modifiers for declaration() methods.

Parameters:

modifiers - See Modifier.

Returns:

DocumentFragment

type

default FluentNode type(Tag tag,
                        Type type)

Method to generate types for declaration() methods.

Parameters:

tag - The Tag.

type - The target Type.

Returns:

DocumentFragment

table

default FluentNode table(Tag tag,
                         TableModel model,
                         Stream<Node> stream)

<table>model</table>

Parameters:

tag - The Tag.

model - The TableModel to use to create the new table Element.

stream - The Stream of Nodes to append to the newly created Element.

Returns:

Element

table

default FluentNode table(Tag tag,
                         TableModel model,
                         Node... nodes)

<table>model</table>

Parameters:

tag - The Tag.

model - The TableModel to use to create the new table Element.

nodes - The Nodes to append to the newly created Element.

Returns:

Element

toHTML

default FluentNode toHTML(Tag tag,
                          Object object)

Method to get a Javadoc HTML representation of an Object.

Parameters:

tag - The Tag.

object - The target Object.

Returns:

Node