package help
Ordering
- Alphabetic
Visibility
- Public
- Protected
Type Members
- case class Doc(short: String, long: String = "", example: String = "") extends Annotation with StaticAnnotation with Product with Serializable
Annotation used for documentation.
Annotation used for documentation.
- short
a one line description for the overview table
- long
in-depth documentation
a short example for the overview table
Example: - case class Table(columnNames: Iterable[String], rows: Iterable[Iterable[String]]) extends Product with Serializable
- trait Traversal extends Annotation
- class TraversalHelp extends AnyRef
traversalExtBasePackage: The base package that we scan for @TraversalExt annotations.
traversalExtBasePackage: The base package that we scan for @TraversalExt annotations. Note that this restricts us to only find @Doc annotations in classes in that namespace and it's children. If left empty, the scan takes considerable amount of time (depending on your classpath, obviously).
- trait TraversalSource extends Annotation
Value Members
- object Doc extends Serializable