package doc
- Alphabetic
- Public
- All
Type Members
-
class
CodeReferenceNode extends AbstractNode
A code reference node
-
class
CodeReferenceParser extends Parser with BlockPluginParser
Parboiled parser for code references in markdown.
Parboiled parser for code references in markdown.
Implemented in Java because this is necessary for parboiled enhancement to work.
-
case class
FileHandle(name: String, size: Long, is: InputStream, close: () ⇒ Unit) extends Product with Serializable
Access to file data, provided to the handler when
handleFile
is called.Access to file data, provided to the handler when
handleFile
is called.- name
The name of the file.
- size
The size of the file in bytes.
- is
A stream with the file data.
- close
Used by the handler to close the file when the handler is finished.
-
trait
FileRepository extends AnyRef
Repository for loading files
-
class
FilesystemRepository extends FileRepository
Simple filesystem implementation of the FileRepository
-
class
JarRepository extends FileRepository
Jar file implementation of the repository
-
case class
Page(page: String, path: Option[String], title: String, nav: List[Toc], nextLinks: List[TocTree]) extends Product with Serializable
A page
A page
- page
The page name
- path
The path to the page
- title
The title of the page
- nav
The navigation associated with the page, this is a list of all the table of contents nodes, starting from the one that this page is in, all the way up the tree to the root node
- nextLinks
A list of next links
-
class
PageIndex extends AnyRef
The page index
-
class
PlayDoc extends AnyRef
Play documentation support
-
trait
PlayDocTemplates extends AnyRef
Templates for rendering Play documentation snippets.
-
case class
RenderedPage(html: String, sidebarHtml: Option[String], path: String, breadcrumbsHtml: Option[String]) extends Product with Serializable
A rendered page
A rendered page
- html
The HTML for the page
- sidebarHtml
The HTML for the sidebar
- path
The path that the page was found at
- breadcrumbsHtml
The HTML for the breadcrumbs.
-
case class
Toc(name: String, title: String, nodes: List[(String, TocTree)], descend: Boolean = true) extends TocTree with Product with Serializable
A table of contents
A table of contents
- title
The title of this table of contents
- nodes
The nodes in the table of contents
- descend
Whether a table of contents should descend into this table of contents
-
class
TocNode extends AbstractNode
A table of contents node
-
case class
TocPage(page: String, title: String, next: Option[List[String]]) extends TocTree with Product with Serializable
A page (leaf node) pointed to by the table of contents
A page (leaf node) pointed to by the table of contents
- page
The page
- title
The title of the page
- next
Explicitly provided next links. If None, then the index structure are used to generate the next links, otherwise these links should be used. Note that
Some(Nil)
is distinct fromNone
, in thatSome(Nil)
means there should be no next links, whereasNone
means let the index decide what the next link should be.
-
class
TocParser extends Parser with BlockPluginParser
Parser for parsing variables that are substituted with arbitrary text.
-
sealed
trait
TocTree extends AnyRef
A table of contents node
- class TranslatedPlayDocTemplates extends PlayDocTemplates
-
class
VariableNode extends AbstractNode
A dynamic variable node
-
class
VariableParser extends Parser with InlinePluginParser
Parser for parsing variables that are substituted with arbitrary text.
Value Members
- object PageIndex
- object PlayDocTemplates extends TranslatedPlayDocTemplates
-
object
PrettifyVerbatimSerializer extends VerbatimSerializer
Prints verbatim nodes in such a format that Google Code Prettify will work with them