org.specs2.specification

SpecStart

Related Doc: package specification

case class SpecStart(specName: SpecName, arguments: Arguments = Arguments(), linked: Linked = Linked(), location: Location = new Location) extends Fragment with Product with Serializable

Start of a specification.

This fragment keeps 2 important pieces of information:

Linear Supertypes
Serializable, Serializable, Product, Equals, Fragment, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SpecStart
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Fragment
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SpecStart(specName: SpecName, arguments: Arguments = Arguments(), linked: Linked = Linked(), location: Location = new Location)

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. val arguments: Arguments

  5. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  6. def baseDirIs(dir: String): SpecStart

    set the base directory for the generated documentation

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  9. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  10. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  11. def hidden: Boolean

    returns

    true if this spec must not be displayed

  12. def isIncludeLink: Boolean

    returns

    true if this spec starts only contains a link including another specification

  13. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  14. def isLink: Boolean

    returns

    true if this spec starts only contains a link to another specification

  15. def isSeeOnlyLink: Boolean

    returns

    true if this spec starts only contains a link referencing another specification

  16. def link: Option[HtmlLink]

    returns

    the html link if any

  17. def linkToString: String

  18. val linked: Linked

  19. val location: Location

    Definition Classes
    SpecStart → Fragment

  20. def matches(s: String): Boolean

    Definition Classes
    SpecStart → Fragment

  21. def name: String

  22. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  23. final def notify(): Unit

    Definition Classes
    AnyRef

  24. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  25. def overrideArgs(args: Arguments): SpecStart

    the new arguments take override the old ones where defined

  26. val specName: SpecName

  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  28. def title: String

  29. def toString(): String

    Definition Classes
    SpecStart → AnyRef → Any

  30. def unlink: SpecStart

    returns

    a non-linked start

  31. def urlIs(url: String): SpecStart

    set the url for the generated documentation

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. def withArgs(args: Arguments): SpecStart

    the new arguments take precedence over the old ones

  36. def withName(n: SpecName): SpecStart

    The name of the specification can be overriden with a user defined title

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Fragment

Inherited from AnyRef

Inherited from Any

Ungrouped