Package com.io7m.minisite.core

Interface MinDocumentationFormatType

All Known Implementing Classes:

MinDocumentationFormat

@Immutable
public interface MinDocumentationFormatType

Configuration for a documentation format.

Method Summary

Modifier and Type	Method	Description
java.lang.String	name()
java.nio.file.Path	path()

Method Detail

name

@Parameter
java.lang.String name()

Returns:

The name of the format, such as "XHTML - one page per section"

path

@Parameter
java.nio.file.Path path()

Returns:

The path to the format, such as "/documentation/index-m.xhtml"