Packages

object Help

User friendly help messages generator.

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

Type Members

  1. case class Description(s: String) extends Annotation with StaticAnnotation with Product with Serializable

    A longer description of the method

  2. case class Group(name: String) extends Annotation with StaticAnnotation with Product with Serializable

    A tag to indicate nesting of items

  3. case class Item(name: String, signature: Option[MethodSignature], summary: Summary, description: Description, topic: Topic, subItems: Seq[Item] = Seq.empty) extends Product with Serializable
  4. case class MethodSignature(argsWithTypes: Seq[(String, String)], retType: String) extends Product with Serializable
  5. case class Summary(s: String, flag: FeatureFlag = FeatureFlag.Stable) extends Annotation with StaticAnnotation with Product with Serializable

    A short summary of the method (to be displayed in a list)

    A short summary of the method (to be displayed in a list)

    Note that the annotation parser is also hard-coded to the default flag Stable

  6. case class Topic(t: Seq[String]) extends Annotation with StaticAnnotation with Product with Serializable

    A sequence of strings classifying the method breadcrumb style (e.g.

    A sequence of strings classifying the method breadcrumb style (e.g. Seq("Participant", "Diagnostics")). Used as headings in the displayed help.

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. val defaultTopLevelTopic: Seq[String]
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def flattenItem(path: Seq[String])(item: Item): Seq[Item]
  10. def flattenItemsForManual(items: Seq[Item]): Seq[Item]
  11. def forInstance[T](instance: T, baseTopic: Seq[String] = Seq(), scope: Set[FeatureFlag] = FeatureFlag.all)(implicit arg0: ClassTag[T]): String

    Generate help messages from an object instance using reflection, using only the given summaries.

    Generate help messages from an object instance using reflection, using only the given summaries.

    ARGUMENTS OF THE ANNOTATIONS MUST BE LITERALS (CONSTANTS) (e.g., Topic(topicVariable) does not work).

    All methods with a Summary annotation will be included. Description or Topic are also included if present, and are set to the empty string otherwise. We attempt to make as friendly as possible:

    • Unit types are not displayed
    • Empty argument lists are dropped
    • Implicits are hidden See corresponding tests for examples.
  12. def forMethod(items: Seq[Item], methodName: String): String
  13. def forMethod[T](instance: T, methodName: String, scope: Set[FeatureFlag] = FeatureFlag.all)(implicit arg0: ClassTag[T]): String
  14. def format(items: Item*): String

    Format help for named items and their descriptions

    Format help for named items and their descriptions

    items

    Tuple of name and description

  15. def formatItem(item: Item): String
  16. def fromObject[T](instance: T)(implicit arg0: ClassTag[T]): Seq[Item]
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def getItems[T](instance: T, baseTopic: Seq[String] = Seq(), scope: Set[FeatureFlag] = FeatureFlag.all)(implicit arg0: ClassTag[T]): Seq[Item]
  19. def getItemsFlattenedForManual[T](instance: T, baseTopic: Seq[String] = Seq())(implicit arg0: ClassTag[T]): Seq[Item]
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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