c

play.doc

PlayDoc

class PlayDoc extends AnyRef

Play documentation support

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayDoc
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PlayDoc(markdownRepository: FileRepository, codeRepository: FileRepository, resources: String, playVersion: String, pageIndex: Option[PageIndex], templates: PlayDocTemplates, pageExtension: Option[String])

    markdownRepository

    Repository for finding markdown files

    codeRepository

    Repository for finding code samples

    resources

    The resources path

    playVersion

    The version of Play we are rendering docs for.

    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.

    templates

    The templates to render snippets.

    pageExtension

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val PlayVersionVariableName: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. val pageIndex: Option[PageIndex]
  16. def render(markdown: String, relativePath: Option[File] = None): String

    Render some markdown.

  17. def renderAllPages(singlePage: Boolean): List[(String, String)]

    Render all the pages of the documentation

    Render all the pages of the documentation

    singlePage

    Whether the pages are being rendered to be formatted on a single page

  18. def renderPage(pageName: String): Option[RenderedPage]

    Render a Play documentation page.

    Render a Play documentation page.

    pageName

    The page to render, without path or markdown extension.

    returns

    If found a tuple of the rendered page and the rendered sidebar, if the sidebar was found.

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped