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

implicit class PackageAccess extends TemplateAccess

Source
ScaladocModelTest.scala
Linear Supertypes
TemplateAccess, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PackageAccess
  2. TemplateAccess
  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. Protected

Instance Constructors

  1. new PackageAccess(pack: Package)

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 PackageAccess toany2stringadd[PackageAccess] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (PackageAccess, B)
    Implicit
    This member is added by an implicit conversion from PackageAccess toArrowAssoc[PackageAccess] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def _absType(name: String): MemberEntity
    Definition Classes
    TemplateAccess
  7. def _absTypeTpl(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  8. def _absTypeTpls(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  9. def _absTypes(name: String): List[MemberEntity]
    Definition Classes
    TemplateAccess
  10. def _aliasType(name: String): MemberEntity
    Definition Classes
    TemplateAccess
  11. def _aliasTypeTpl(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  12. def _aliasTypeTpls(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  13. def _aliasTypes(name: String): List[MemberEntity]
    Definition Classes
    TemplateAccess
  14. def _annotation(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  15. def _annotations(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  16. def _class(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  17. def _classMbr(name: String): MemberTemplateEntity
    Definition Classes
    TemplateAccess
  18. def _classes(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  19. def _classesMbr(name: String): List[MemberTemplateEntity]
    Definition Classes
    TemplateAccess
  20. def _conversion(name: String): ImplicitConversion
    Definition Classes
    TemplateAccess
  21. def _conversions(name: String): List[ImplicitConversion]
    Definition Classes
    TemplateAccess
  22. def _method(name: String): Def
    Definition Classes
    TemplateAccess
  23. def _methods(name: String): List[Def]
    Definition Classes
    TemplateAccess
  24. def _object(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  25. def _objectMbr(name: String): MemberTemplateEntity
    Definition Classes
    TemplateAccess
  26. def _objects(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  27. def _objectsMbr(name: String): List[MemberTemplateEntity]
    Definition Classes
    TemplateAccess
  28. def _package(name: String): Package
  29. def _packages(name: String): List[Package]
  30. def _trait(name: String): DocTemplateEntity
    Definition Classes
    TemplateAccess
  31. def _traitMbr(name: String): MemberTemplateEntity
    Definition Classes
    TemplateAccess
  32. def _traits(name: String): List[DocTemplateEntity]
    Definition Classes
    TemplateAccess
  33. def _traitsMbr(name: String): List[MemberTemplateEntity]
    Definition Classes
    TemplateAccess
  34. def _value(name: String): Val
    Definition Classes
    TemplateAccess
  35. def _values(name: String): List[Val]
    Definition Classes
    TemplateAccess
  36. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  37. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  38. def ensuring(cond: (PackageAccess) => Boolean, msg: => Any): PackageAccess
    Implicit
    This member is added by an implicit conversion from PackageAccess toEnsuring[PackageAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  39. def ensuring(cond: (PackageAccess) => Boolean): PackageAccess
    Implicit
    This member is added by an implicit conversion from PackageAccess toEnsuring[PackageAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  40. def ensuring(cond: Boolean, msg: => Any): PackageAccess
    Implicit
    This member is added by an implicit conversion from PackageAccess toEnsuring[PackageAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  41. def ensuring(cond: Boolean): PackageAccess
    Implicit
    This member is added by an implicit conversion from PackageAccess toEnsuring[PackageAccess] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  42. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  44. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  45. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from PackageAccess toStringFormat[PackageAccess] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  46. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  47. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  48. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def →[B](y: B): (PackageAccess, B)
    Implicit
    This member is added by an implicit conversion from PackageAccess toArrowAssoc[PackageAccess] 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 TemplateAccess

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromPackageAccess to any2stringadd[PackageAccess]

Inherited by implicit conversion StringFormat fromPackageAccess to StringFormat[PackageAccess]

Inherited by implicit conversion Ensuring fromPackageAccess to Ensuring[PackageAccess]

Inherited by implicit conversion ArrowAssoc fromPackageAccess to ArrowAssoc[PackageAccess]

Ungrouped