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

scala.tools.partest.ScaladocModelTest.access

DocTemplateEntityMembers