c

scala.tools.partest

ScaladocModelTest

abstract class ScaladocModelTest extends DirectTest

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")
  }
}
Source
ScaladocModelTest.scala
Linear Supertypes
DirectTest, AnyRef, Any
Known Subclasses
ScaladocJavaModelTest
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ScaladocModelTest
  2. DirectTest
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ScaladocModelTest()

Abstract Value Members

  1. abstract def scaladocSettings: String

    Override this to give scaladoc command line parameters

  2. abstract def testModel(root: Package): Unit

    Override this to test the model

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 ScaladocModelTest to any2stringadd[ScaladocModelTest] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ScaladocModelTest, B)
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to ArrowAssoc[ScaladocModelTest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def code: String

    Override to feed code into scaladoc

    Override to feed code into scaladoc

    Definition Classes
    ScaladocModelTest → DirectTest
  9. def compilationUnits(global: Global)(sourceCodes: String*): List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  10. def compile(args: String*): Boolean
    Definition Classes
    DirectTest
  11. def compileString(global: Global)(sourceCode: String): Boolean
    Definition Classes
    DirectTest
  12. def ensuring(cond: (ScaladocModelTest) ⇒ Boolean, msg: ⇒ Any): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to Ensuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (ScaladocModelTest) ⇒ Boolean): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to Ensuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to Ensuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): ScaladocModelTest
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to Ensuring[ScaladocModelTest] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def extraSettings: String
    Definition Classes
    ScaladocModelTest → DirectTest
  19. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def javaCompilationUnits(global: Global)(sourceCodes: String*): List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  24. def main(args: Array[String]): Unit

    Constructor/main body *

    Constructor/main body *

    Definition Classes
    DirectTest
  25. def model: Option[Universe]
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def newCompiler(settings: Settings): Global
    Definition Classes
    DirectTest
  28. def newCompiler(args: String*): Global
    Definition Classes
    DirectTest
  29. def newDocFactory: DocFactory
  30. def newJavaSources(codes: String*): List[BatchSourceFile]
    Definition Classes
    DirectTest
  31. def newSettings(args: List[String]): Settings
    Definition Classes
    DirectTest
  32. def newSources(codes: String*): List[BatchSourceFile]
    Definition Classes
    DirectTest
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  35. def reporter(settings: Settings): Reporter
    Definition Classes
    DirectTest
  36. def resourceFile: String

    Override to feed a file in resources to scaladoc

  37. def resourcePath: reflect.io.Directory
  38. def settings: Settings
    Definition Classes
    DirectTest
  39. def show(): Unit
    Definition Classes
    ScaladocModelTest → DirectTest
  40. def sourceFilesToCompiledUnits(global: Global)(files: List[SourceFile]): List[nsc.Global.CompilationUnit]
    Definition Classes
    DirectTest
  41. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  42. def testOutput: reflect.io.Directory
    Definition Classes
    DirectTest
  43. def testPath: reflect.io.File
    Definition Classes
    DirectTest
  44. def testUnderJavaAtLeast[A](version: String)(yesRun: ⇒ A): TestUnderJavaAtLeast[A]

    Run a test only if the current java version is at least the version specified.

    Run a test only if the current java version is at least the version specified.

    Definition Classes
    DirectTest
  45. def toString(): String
    Definition Classes
    AnyRef → Any
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. def withRun[T](global: Global)(f: (Run) ⇒ T): T
    Definition Classes
    DirectTest
  50. def →[B](y: B): (ScaladocModelTest, B)
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to ArrowAssoc[ScaladocModelTest] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
  51. object access

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ScaladocModelTest to StringFormat[ScaladocModelTest] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

Inherited from DirectTest

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ScaladocModelTest to any2stringadd[ScaladocModelTest]

Inherited by implicit conversion StringFormat from ScaladocModelTest to StringFormat[ScaladocModelTest]

Inherited by implicit conversion Ensuring from ScaladocModelTest to Ensuring[ScaladocModelTest]

Inherited by implicit conversion ArrowAssoc from ScaladocModelTest to ArrowAssoc[ScaladocModelTest]

Ungrouped