Package com.github.cukedoctor.api

Interface CukedoctorConverter

All Known Implementing Classes:

CukedoctorConverterImpl

public interface CukedoctorConverter

Created by pestano on 02/06/15.

Method Summary

Modifier and Type	Method	Description
CukedoctorConverter	addCustomCss()
CukedoctorConverter	addCustomPdfTheme()
String	getDocumentation()
String	getDocumentationTitle()
DocumentAttributes	getDocumentAttributes()
List<Feature>	getFeatures()
String	getFilename()
CukedoctorConverter	renderAttributes()	Deprecated. Use an appropriate instance of HeaderRenderer to render the document attributes only e.g.
String	renderDocumentation()
CukedoctorConverter	renderFeatures()	Deprecated. Use an appropriate instance of FeatureRenderer to render the document features only e.g.
CukedoctorConverter	renderFeatures(List<Feature> features)	Deprecated. Use an appropriate instance of FeatureRenderer to render the document features only e.g.
CukedoctorConverter	renderSummary()	Deprecated. Use an appropriate instance of SummaryRenderer to render the document summary only e.g.
CukedoctorConverter	saveDocumentation()	Saves the documentation into disk using getFilename() as name (also path).
CukedoctorConverter	setFilename(String filename)	set output file name without extension (should always be .adoc or other asciidoc compatible extensions) If no filename is set then Documentation title (first H1 section) will be used as filename (underline will be used to remove spaces) The filename is used mainly for asciidoc docinfo creation.

Method Detail

getDocumentAttributes

DocumentAttributes getDocumentAttributes()

getFeatures

List<Feature> getFeatures()

getDocumentation

String getDocumentation()

renderDocumentation

String renderDocumentation()

Returns:

a string representation of the current document in Asciidoctor format

getDocumentationTitle

String getDocumentationTitle()

renderFeatures

@Deprecated
CukedoctorConverter renderFeatures(List<Feature> features)

Deprecated.

Use an appropriate instance of FeatureRenderer to render the document features only e.g. CukedoctorFeatureRenderer

Parameters:

features - the features to render

Returns:

underlying Converter instance

renderFeatures

@Deprecated
CukedoctorConverter renderFeatures()

Deprecated.

Use an appropriate instance of FeatureRenderer to render the document features only e.g. CukedoctorFeatureRenderer

Returns:

underlying Converter instance

renderAttributes

@Deprecated
CukedoctorConverter renderAttributes()

Deprecated.

Use an appropriate instance of HeaderRenderer to render the document attributes only e.g. CukedoctorHeaderRenderer

Returns:

underlying Converter instance

renderSummary

@Deprecated
CukedoctorConverter renderSummary()

Deprecated.

Use an appropriate instance of SummaryRenderer to render the document summary only e.g. CukedoctorSummaryRenderer

Returns:

underlying Converter instance

setFilename

CukedoctorConverter setFilename(String filename)

set output file name without extension (should always be .adoc or other asciidoc compatible extensions) If no filename is set then Documentation title (first H1 section) will be used as filename (underline will be used to remove spaces) The filename is used mainly for asciidoc docinfo creation.

Parameters:

filename - name to be set

Returns:

underlying Converter instance

getFilename

String getFilename()

addCustomCss

CukedoctorConverter addCustomCss()

addCustomPdfTheme

CukedoctorConverter addCustomPdfTheme()

saveDocumentation

CukedoctorConverter saveDocumentation()

Saves the documentation into disk using getFilename() as name (also path). Note that

Returns:

underlying Converter instance

See Also:

will be called and used as content to save the file.