play-doc
API
Generated with
play-doc/play.doc

play.doc

package play.doc

Members list

Packages

package play.doc.html

Type members

Classlikes

case class FileHandle(name: String, size: Long, is: InputStream, close: () => Unit)

Access to file data, provided to the handler when handleFile is called.

Access to file data, provided to the handler when handleFile is called.

Value parameters

close

Used by the handler to close the file when the handler is finished.

is

A stream with the file data.

name

The name of the file.

size

The size of the file in bytes.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait FileRepository

Repository for loading files

Repository for loading files

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class FilesystemRepository(base: File) extends FileRepository

Simple filesystem implementation of the FileRepository

Simple filesystem implementation of the FileRepository

Value parameters

base

The base dir of the file

Attributes

Supertypes
class Object
trait Matchable
class Any
class JarRepository(jarFile: JarFile, base: Option[String]) extends FileRepository

Jar file implementation of the repository

Jar file implementation of the repository

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Page(page: String, path: Option[String], title: String, nav: List[Toc], nextLinks: List[TocTree])

A page

A page

Value parameters

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

page

The page name

path

The path to the page

title

The title of the page

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class PageIndex(val toc: Toc, path: Option[String])

The page index

The page index

Value parameters

toc

The table of contents

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object PageIndex

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
PageIndex.type
class PlayDoc(markdownRepository: FileRepository, codeRepository: FileRepository, resources: String, playVersion: String, val pageIndex: Option[PageIndex], templates: PlayDocTemplates, pageExtension: Option[String])

Play documentation support

Play documentation support

Value parameters

codeRepository

Repository for finding code samples

markdownRepository

Repository for finding markdown files

pageExtension

The extension to add to rendered pages - used for rendering links.

pageIndex

An optional page index. If None, will use the old approach of searching up the heirarchy for sidebar pages, otherwise will use the page index to render the sidebar.

playVersion

The version of Play we are rendering docs for.

resources

The resources path

templates

The templates to render snippets.

Attributes

Supertypes
class Object
trait Matchable
class Any
trait PlayDocTemplates

Templates for rendering Play documentation snippets.

Templates for rendering Play documentation snippets.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PlayDocTemplates.type
object PlayDocTemplates extends TranslatedPlayDocTemplates

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object PrettifyVerbatimSerializer extends VerbatimSerializer

Prints verbatim nodes in such a format that Google Code Prettify will work with them

Prints verbatim nodes in such a format that Google Code Prettify will work with them

Attributes

Supertypes
trait VerbatimSerializer
class Object
trait Matchable
class Any
Self type
case class RenderedPage(html: String, sidebarHtml: Option[String], path: String, breadcrumbsHtml: Option[String])

A rendered page

A rendered page

Value parameters

breadcrumbsHtml

The HTML for the breadcrumbs.

html

The HTML for the page

path

The path that the page was found at

sidebarHtml

The HTML for the sidebar

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Toc(name: String, title: String, nodes: List[(String, TocTree)], descend: Boolean) extends TocTree

A table of contents

A table of contents

Value parameters

descend

Whether a table of contents should descend into this table of contents

nodes

The nodes in the table of contents

title

The title of this table of contents

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TocTree
class Object
trait Matchable
class Any
Show all
case class TocPage(page: String, title: String, next: Option[List[String]]) extends TocTree

A page (leaf node) pointed to by the table of contents

A page (leaf node) pointed to by the table of contents

Value parameters

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 from None, in that Some(Nil) means there should be no next links, whereas None means let the index decide what the next link should be.

page

The page

title

The title of the page

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TocTree
class Object
trait Matchable
class Any
Show all
sealed trait TocTree

A table of contents node

A table of contents node

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Toc
class TocPage
class TranslatedPlayDocTemplates(nextText: String) extends PlayDocTemplates

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PlayDocTemplates.type
Generated with