Packages

case class DocComment(raw: String, pos: Global.Position = NoPosition, codePos: Global.Position = NoPosition) extends Product with Serializable

Source
DocComments.scala
Linear Supertypes
java.io.Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocComment
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DocComment(raw: String, pos: Global.Position = NoPosition, codePos: Global.Position = NoPosition)

Value Members

  1. val codePos: Global.Position
  2. def defineVariables(sym: Global.Symbol): Unit
  3. lazy val defines: collection.immutable.List[String]

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)

  4. val pos: Global.Position
  5. def productElementNames: Iterator[String]
    Definition Classes
    Product
  6. val raw: String
  7. lazy val template: String

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)

  8. lazy val useCases: collection.immutable.List[Global.UseCase]

    Returns: template: the doc comment minus all @define and @usecase sections defines : all define sections (as strings) useCases: all usecase sections (as instances of class UseCase)