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 TemplateAccess extends AnyRef

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

Instance Constructors

  1. new TemplateAccess(tpl: DocTemplateEntity)

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

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from TemplateAccess toStringFormat[TemplateAccess] 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.

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

Inherited by implicit conversion StringFormat fromTemplateAccess to StringFormat[TemplateAccess]

Inherited by implicit conversion Ensuring fromTemplateAccess to Ensuring[TemplateAccess]

Inherited by implicit conversion ArrowAssoc fromTemplateAccess to ArrowAssoc[TemplateAccess]

Ungrouped