root
API
Generated with
root/play.docs/DocumentationHandler

DocumentationHandler

play.docs.DocumentationHandler
class DocumentationHandler(repo: FileRepository, apiRepo: FileRepository, toClose: Closeable) extends BuildDocHandler, Closeable

Used by the DocumentationApplication class to handle requests for Play documentation. Documentation is located in the given repository - either a JAR file or directly from the filesystem.

Attributes

Graph
Supertypes
trait Closeable
trait AutoCloseable
class Object
trait Matchable
class Any
Show all

Members list

Value members

Constructors

def this(repo: FileRepository, toClose: Closeable)
def this(repo: FileRepository, apiRepo: FileRepository)
def this(repo: FileRepository)

Concrete methods

def close(): Unit
override def maybeHandleDocRequest(request: AnyRef): AnyRef

Attributes

Definition Classes
def maybeHandleDocRequest(request: RequestHeader): Option[Result]

Handle the given request if it is a request for documentation content.

Handle the given request if it is a request for documentation content.

Attributes

def playDoc: PlayDoc

This is a def because we want to reindex the docs each time.

This is a def because we want to reindex the docs each time.

Attributes

Concrete fields

Generated with