Class

play.docs

DocumentationHandler

Related Doc: package docs

Permalink

class DocumentationHandler extends BuildDocHandler with 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.

Linear Supertypes
Closeable, AutoCloseable, BuildDocHandler, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentationHandler
  2. Closeable
  3. AutoCloseable
  4. BuildDocHandler
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DocumentationHandler(repo: FileRepository)

    Permalink

  2. new DocumentationHandler(repo: FileRepository, apiRepo: FileRepository)

    Permalink

  3. new DocumentationHandler(repo: FileRepository, toClose: Closeable)

    Permalink

  4. new DocumentationHandler(repo: FileRepository, apiRepo: FileRepository, toClose: Closeable)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. def close(): Unit

    Permalink
    Definition Classes
    DocumentationHandler → Closeable → AutoCloseable

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  11. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  13. val locator: (String) ⇒ String

    Permalink

  14. def maybeHandleDocRequest(request: RequestHeader): Option[Result]

    Permalink

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

  15. def maybeHandleDocRequest(request: AnyRef): AnyRef

    Permalink
    Definition Classes
    DocumentationHandler → BuildDocHandler

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. def playDoc: PlayDoc

    Permalink

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

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Closeable

Inherited from AutoCloseable

Inherited from BuildDocHandler

Inherited from AnyRef

Inherited from Any

Ungrouped