Packages

  • package root
    Definition Classes
    root
  • package scala
    Definition Classes
    root
  • package tools
    Definition Classes
    scala
  • package partest
    Definition Classes
    tools
  • abstract class ScaladocModelTest extends DirectTest

    A class for testing scaladoc model generation

    A class for testing scaladoc model generation

    • you need to specify the code in the code method
    • you need to override the testModel method to test the model
    • you may specify extra parameters to send to scaladoc in scaladocSettings
    import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest

object Test extends ScaladocModelTest {

  override def code = """ ... """ // or override def resourceFile = "<file>.scala" (from test/scaladoc/resources)
  def scaladocSettings = " ... "
  def testModel(rootPackage: Package) = {
    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
    import access._

    // just need to check the member exists, access methods will throw an error if there's a problem
    rootPackage._package("scala")._package("test")._class("C")._method("foo")
  }
}
    Definition Classes
    partest
  • object access
    Definition Classes
    ScaladocModelTest
  • DocTemplateEntityMembers
  • ImplicitConversionMembers
  • PackageAccess
  • TemplateAccess
  • WithMembers

trait WithMembers extends AnyRef

Source
ScaladocModelTest.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
DocTemplateEntityMembers, ImplicitConversionMembers
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WithMembers
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def members: List[MemberEntity]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WithMembers toany2stringadd[WithMembers] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WithMembers, B)
    Implicit
    This member is added by an implicit conversion from WithMembers toArrowAssoc[WithMembers] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _member(name: String): MemberEntity
  7. def _members(name: String): List[MemberEntity]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def ensuring(cond: (WithMembers) => Boolean, msg: => Any): WithMembers
    Implicit
    This member is added by an implicit conversion from WithMembers toEnsuring[WithMembers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (WithMembers) => Boolean): WithMembers
    Implicit
    This member is added by an implicit conversion from WithMembers toEnsuring[WithMembers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): WithMembers
    Implicit
    This member is added by an implicit conversion from WithMembers toEnsuring[WithMembers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): WithMembers
    Implicit
    This member is added by an implicit conversion from WithMembers toEnsuring[WithMembers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WithMembers toStringFormat[WithMembers] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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()

Deprecated Value Members

  1. def →[B](y: B): (WithMembers, B)
    Implicit
    This member is added by an implicit conversion from WithMembers toArrowAssoc[WithMembers] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWithMembers to any2stringadd[WithMembers]

Inherited by implicit conversion StringFormat fromWithMembers to StringFormat[WithMembers]

Inherited by implicit conversion Ensuring fromWithMembers to Ensuring[WithMembers]

Inherited by implicit conversion ArrowAssoc fromWithMembers to ArrowAssoc[WithMembers]

Ungrouped