object Help
User friendly help messages generator.
- Alphabetic
- By Inheritance
- Help
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class Description(s: String) extends Annotation with StaticAnnotation with Product with Serializable
A longer description of the method
- case class Group(name: String) extends Annotation with StaticAnnotation with Product with Serializable
A tag to indicate nesting of items
- case class Item(name: String, signature: Option[MethodSignature], summary: Summary, description: Description, topic: Topic, subItems: Seq[Item] = Seq.empty) extends Product with Serializable
- case class MethodSignature(argsWithTypes: Seq[(String, String)], retType: String) extends Product with Serializable
- 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
- 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
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val defaultTopLevelTopic: Seq[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def flattenItem(path: Seq[String])(item: Item): Seq[Item]
- def flattenItemsForManual(items: Seq[Item]): Seq[Item]
- 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.
- def forMethod(items: Seq[Item], methodName: String): String
- def forMethod[T](instance: T, methodName: String, scope: Set[FeatureFlag] = FeatureFlag.all)(implicit arg0: ClassTag[T]): String
- 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
- def formatItem(item: Item): String
- def fromObject[T](instance: T)(implicit arg0: ClassTag[T]): Seq[Item]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getItems[T](instance: T, baseTopic: Seq[String] = Seq(), scope: Set[FeatureFlag] = FeatureFlag.all)(implicit arg0: ClassTag[T]): Seq[Item]
- def getItemsFlattenedForManual[T](instance: T, baseTopic: Seq[String] = Seq())(implicit arg0: ClassTag[T]): Seq[Item]
- 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()
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])