class PlayDoc extends AnyRef
Play documentation support
- Alphabetic
- By Inheritance
- PlayDoc
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val PlayVersionVariableName: String
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val pageIndex: Option[PageIndex]
-
def
render(markdown: String, relativePath: Option[File] = None): String
Render some markdown.
-
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
-
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated