Package com.io7m.minisite.core

Interface MinDocumentationItemType

All Known Implementing Classes:

MinDocumentationItem

@Immutable
public interface MinDocumentationItemType

Configuration for a documentation item.

Method Summary

Modifier and Type	Method	Description
io.vavr.collection.Vector<MinDocumentationFormat>	formats()
java.lang.String	name()

Method Detail

name

@Parameter
java.lang.String name()

Returns:

The name of the documentation, such as "User documentation"

formats

@Parameter
io.vavr.collection.Vector<MinDocumentationFormat> formats()

Returns:

The list of available formats for the documentation