Class

org.specs2.specification

SpecStart

Related Doc: package specification

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val arguments: Arguments

    Permalink
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def baseDirIs(dir: String): SpecStart

    Permalink

    set the base directory for the generated documentation

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hidden: Boolean

    Permalink

    returns

    true if this spec must not be displayed

  12. def isIncludeLink: Boolean

    Permalink

    returns

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

  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isLink: Boolean

    Permalink

    returns

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

  15. def isSeeOnlyLink: Boolean

    Permalink

    returns

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

  16. def link: Option[HtmlLink]

    Permalink

    returns

    the html link if any

  17. def linkToString: String

    Permalink
  18. val linked: Linked

    Permalink
  19. val location: Location

    Permalink
    Definition Classes
    SpecStartFragment
  20. def matches(s: String): Boolean

    Permalink
    Definition Classes
    SpecStartFragment
  21. def name: String

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

    Permalink
    Definition Classes
    AnyRef
  23. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. def overrideArgs(args: Arguments): SpecStart

    Permalink

    the new arguments take override the old ones where defined

  26. val specName: SpecName

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

    Permalink
    Definition Classes
    AnyRef
  28. def title: String

    Permalink
  29. def toString(): String

    Permalink
    Definition Classes
    SpecStart → AnyRef → Any
  30. def unlink: SpecStart

    Permalink

    returns

    a non-linked start

  31. def urlIs(url: String): SpecStart

    Permalink

    set the url for the generated documentation

  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. def withArgs(args: Arguments): SpecStart

    Permalink

    the new arguments take precedence over the old ones

  36. def withName(n: SpecName): SpecStart

    Permalink

    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