com.threecrickets.scripturian.document

Interface DocumentFormatter<D>

Type Parameters:

D - The document type

All Known Implementing Classes:

JygmentsDocumentFormatter, PygmentsDocumentFormatter, SyntaxHighlighterFormatter

public interface DocumentFormatter<D>

Transforms a document described by a DocumentDescriptor to a different format. Useful for both human- and machine-readable formats.

Author:

Tal Liron

Method Summary

Modifier and Type	Method and Description
String	format(DocumentDescriptor<D> documentDescriptor, String title, int highlightLineNumber) Formats the document or its source code.

Method Detail

format

String format(DocumentDescriptor<D> documentDescriptor,
              String title,
              int highlightLineNumber)

Formats the document or its source code.

Parameters:

documentDescriptor - The document descriptor

title - The result title

highlightLineNumber - The line number to highlight

Returns:

The formatted document