nl.flotsam.pecia
Interface SimpleContents<V>

All Known Subinterfaces:

AnnotatedArticle<T>, AnnotatedSection<T>, Article<T>, ArticleBuilder<T>, ArticleDocument, Contents<V>, Entry<T>, EntryBuilder<T>, LastEntry<T>, LastEntryBuilder<T>, Section<T>, SectionBuilder<T>

All Known Implementing Classes:

DefaultArticleBuilder, DefaultArticleDocument, DefaultEntryBuilder, DefaultLastEntryBuilder, DefaultSectionBuilder, HtmlDocumentBuilder.HtmlColBuilder, HtmlDocumentBuilder.HtmlLastColBuilder

public interface SimpleContents<V>

Method Summary

V	document(Documenter<SimpleContents<?>> target) Generates documentation, and returns the current context.
ItemizedList<? extends V>	itemizedList() Adds an itemized list.
ItemizedList<? extends V>	orderedList() Adds an ordered list.
Para<? extends V>	para() Adds a paragraph.
V	para(String text) Adds a paragraph (Para) containing the text passed in.
Table2Cols<? extends V>	table2Cols() Adds a two-column table.
Table3Cols<? extends V>	table3Cols() Adds a three-column table.
Table4Cols<? extends V>	table4Cols() Adds a four-column table.
Table5Cols<? extends V>	table5Cols() Adds a five-column table.
Verbatim<? extends V>	verbatim() Adds verbatim content.

Method Detail

para

Para<? extends V> para()

Adds a paragraph.

Returns:

The paragraph added.

para

V para(String text)

Adds a paragraph (Para) containing the text passed in.

Parameters:

text - The text to be added to the paragraph.

Returns:

The current element.

verbatim

Verbatim<? extends V> verbatim()

Adds verbatim content.

Returns:

The object representing verbatim content.

itemizedList

ItemizedList<? extends V> itemizedList()

Adds an itemized list.

Returns:

The itemized list just created.

orderedList

ItemizedList<? extends V> orderedList()

Adds an ordered list.

Returns:

The ordered list just created.

table2Cols

Table2Cols<? extends V> table2Cols()

Adds a two-column table.

Returns:

A two column table.

table3Cols

Table3Cols<? extends V> table3Cols()

Adds a three-column table.

Returns:

A three column table.

table4Cols

Table4Cols<? extends V> table4Cols()

Adds a four-column table.

Returns:

A four column table.

table5Cols

Table5Cols<? extends V> table5Cols()

Adds a five-column table.

Returns:

A five column table.

document

V document(Documenter<SimpleContents<?>> target)

Generates documentation, and returns the current context.

Parameters:

target - The object generating the documentation.