final case class Page(name: String = "", content: String = "", subpages: Seq[Page] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) extends GeneratedMessage with Updatable[Page] with Product with Serializable

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

name

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: <pre><code>pages:

  • name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].
content

The Markdown content of the page. You can use <code>&#40;== include {path}

&#41;</code> to include content from a Markdown file.

subpages

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Annotations
@SerialVersionUID()
Linear Supertypes
Product, Equals, Updatable[Page], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Page
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Page(name: String = "", content: String = "", subpages: Seq[Page] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...)

    name

    The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: <pre><code>pages:

    • name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
      • name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference Java page using Markdown reference link syntax: [Java][Tutorial.Java].
    content

    The Markdown content of the page. You can use <code>&#40;== include {path}

    &#41;</code> to include content from a Markdown file.

    subpages

    Subpages of this page. The order of subpages specified here will be honored in the generated docset.

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. def addAllSubpages(__vs: Iterable[Page]): Page
  5. def addSubpages(__vs: Page*): Page
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearSubpages: Page
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companion: Page.type
    Definition Classes
    Page → GeneratedMessage
  10. val content: String
  11. def discardUnknownFields: Page
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    Page → GeneratedMessage
  16. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    Page → GeneratedMessage
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. def serializedSize: Int
    Definition Classes
    Page → GeneratedMessage
  23. val subpages: Seq[Page]
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  26. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  27. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  28. def toProtoString: String
    Definition Classes
    Page → GeneratedMessage
  29. val unknownFields: UnknownFieldSet
  30. def update(ms: (Lens[Page, Page]) ⇒ Mutation[Page]*): Page
    Definition Classes
    Updatable
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def withContent(__v: String): Page
  35. def withName(__v: String): Page
  36. def withSubpages(__v: Seq[Page]): Page
  37. def withUnknownFields(__v: UnknownFieldSet): Page
  38. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  39. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    Page → GeneratedMessage
  40. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[Page]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped