Scala Compiler2.13.18 < Back


# Packages

-  package root

  The Scala compiler and reflection APIs.

  The Scala compiler and reflection APIs.

  Definition Classes
    root
-  package scala
  Definition Classes
    root
-  package tools
  Definition Classes
    scala
-  package nsc
  Definition Classes
    tools
-  package doc
  Definition Classes
    nsc
-  package model
  Definition Classes
    doc
-  class ModelFactory extends AnyRef

  This trait extracts all required information for documentation from compilation units

  This trait extracts all required information for documentation from compilation units

  Definition Classes
    model
- DocTemplateImpl
- EntityImpl
- HigherKindedImpl
- MemberImpl
- MemberTemplateImpl
- NoDocTemplateImpl
- NonTemplateMemberImpl
- NonTemplateParamMemberImpl
- PackageImpl
- ParameterImpl
- RootPackageImpl
- TemplateImpl
- modelCreation

c

scala.tools.nsc.doc.model.ModelFactory

# NoDocTemplateImpl

###

#### class NoDocTemplateImpl extends (ModelFactory.this)#EntityImpl with (ModelFactory.this)#TemplateImpl with (ModelFactory.this)#HigherKindedImpl with NoDocTemplate

A template that is not documented at all. The class is instantiated during lookups, to indicate that the class exists, but should not be documented (either it's not included in the source or it's not visible)

Source
  ModelFactory.scala

Linear Supertypes
NoDocTemplate, (ModelFactory.this)#HigherKindedImpl, HigherKinded, (ModelFactory.this)#TemplateImpl, TemplateEntity, (ModelFactory.this)#EntityImpl, Entity, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. NoDocTemplateImpl
2. NoDocTemplate
3. HigherKindedImpl
4. HigherKinded
5. TemplateImpl
6. TemplateEntity
7. EntityImpl
8. Entity
9. AnyRef
10. 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 NoDocTemplateImpl(sym: Global.Symbol, inTpl: (ModelFactory.this)#TemplateImpl)

### 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 (ModelFactory.this)#NoDocTemplateImpl toany2stringadd[(ModelFactory.this)#NoDocTemplateImpl] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): ((ModelFactory.this)#NoDocTemplateImpl, B)
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toArrowAssoc[(ModelFactory.this)#NoDocTemplateImpl] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  def annotations: collection.immutable.List[Annotation]

   The annotations attached to this entity, if any.

   The annotations attached to this entity, if any.

   Definition Classes
     EntityImpl → Entity
7.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
8.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws(classOf[java.lang.CloneNotSupportedException]) @native()
9.  def ensuring(cond: ((ModelFactory.this)#NoDocTemplateImpl) => Boolean, msg: => Any): (ModelFactory.this)#NoDocTemplateImpl
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toEnsuring[(ModelFactory.this)#NoDocTemplateImpl] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: ((ModelFactory.this)#NoDocTemplateImpl) => Boolean): (ModelFactory.this)#NoDocTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toEnsuring[(ModelFactory.this)#NoDocTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): (ModelFactory.this)#NoDocTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toEnsuring[(ModelFactory.this)#NoDocTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): (ModelFactory.this)#NoDocTemplateImpl
    Implicit
      This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toEnsuring[(ModelFactory.this)#NoDocTemplateImpl] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
13.  final def eq(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
14.  def equals(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef → Any
15.  def finalize(): Unit
    Attributes
      protected[lang]
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.Throwable])
16.  final def getClass(): java.lang.Class[_ <: AnyRef]
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
17.  def hashCode(): Int
    Definition Classes
      AnyRef → Any
    Annotations
      @native()
18.  def inPackageObject: Boolean

    Whether or not the template was defined in a package object

    Whether or not the template was defined in a package object

    Definition Classes
      EntityImpl → Entity
19.  def inTemplate: (ModelFactory.this)#TemplateImpl

    The template of which this entity is a member.

    The template of which this entity is a member.

    Definition Classes
      EntityImpl → Entity
20.  val inTpl: (ModelFactory.this)#TemplateImpl
    Definition Classes
      EntityImpl
21.  def isCase: Boolean

    Whether this template is a case class or a case object.

    Whether this template is a case class or a case object.

    Definition Classes
      TemplateImpl → TemplateEntity
22.  def isClass: Boolean

    Whether this template is a class.

    Whether this template is a class.

    Definition Classes
      TemplateImpl → TemplateEntity
23.  def isDocTemplate: Boolean

    Whether documentation is available for this template.

    Whether documentation is available for this template.

    Definition Classes
      NoDocTemplateImpl → TemplateEntity
24.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
25.  def isObject: Boolean

    Whether this template is an object.

    Whether this template is an object.

    Definition Classes
      TemplateImpl → TemplateEntity
26.  def isPackage: Boolean

    Whether this template is a package (including the root package).

    Whether this template is a package (including the root package).

    Definition Classes
      TemplateImpl → TemplateEntity
27.  def isRootPackage: Boolean

    Whether this template is the root package.

    Whether this template is the root package.

    Definition Classes
      TemplateImpl → TemplateEntity
28.  def isTrait: Boolean

    Whether this template is a trait.

    Whether this template is a trait.

    Definition Classes
      TemplateImpl → TemplateEntity
29.  def isType: Boolean

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

    Indicates whether this entity lives in the types namespace (classes, traits, abstract/alias types)

    Definition Classes
      EntityImpl → Entity
30.  def kind: String

    The kind of the entity

    The kind of the entity

    Definition Classes
      NoDocTemplate → Entity
31.  val name: String

    The name of the entity.

    The name of the entity. Note that the name does not qualify this entity uniquely; use its `qualifiedName` instead.

    Definition Classes
      EntityImpl → Entity
32.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
33.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
34.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native()
35.  def qualifiedName: String

    The qualified name of the entity.

    The qualified name of the entity. This is this entity's name preceded by the qualified name of the template of which this entity is a member. The qualified name is unique to this entity.

    Definition Classes
      TemplateImpl → EntityImpl → Entity
36.  def selfType: Option[TypeEntity]

    The self-type of this template, if it differs from the template type.

    The self-type of this template, if it differs from the template type.

    Definition Classes
      TemplateImpl → TemplateEntity
37.  val sym: Global.Symbol
    Definition Classes
      EntityImpl
38.  final def synchronized[T0](arg0: => T0): T0
    Definition Classes
      AnyRef
39.  def toRoot: List[(ModelFactory.this)#EntityImpl]

    The list of entities such that each is a member of the entity that follows it; the first entity is always this entity, the last the root package entity.

    The list of entities such that each is a member of the entity that follows it; the first entity is always this entity, the last the root package entity.

    Definition Classes
      EntityImpl → Entity
40.  def toString(): String

    The qualified name of this entity.

    The qualified name of this entity.

    Definition Classes
      Entity → AnyRef → Any
41.  def typeParams: collection.immutable.List[TypeParam]

    The type parameters of this entity.

    The type parameters of this entity.

    Definition Classes
      HigherKindedImpl → HigherKinded
42.  val universe: Universe

    The Scaladoc universe of which this entity is a member.

    The Scaladoc universe of which this entity is a member.

    Definition Classes
      EntityImpl → Entity
43.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
44.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])
45.  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 (ModelFactory.this)#NoDocTemplateImpl toStringFormat[(ModelFactory.this)#NoDocTemplateImpl] 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): ((ModelFactory.this)#NoDocTemplateImpl, B)
   Implicit
     This member is added by an implicit conversion from (ModelFactory.this)#NoDocTemplateImpl toArrowAssoc[(ModelFactory.this)#NoDocTemplateImpl] 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 NoDocTemplate

### Inherited from (ModelFactory.this)#HigherKindedImpl

### Inherited from HigherKinded

### Inherited from (ModelFactory.this)#TemplateImpl

### Inherited from TemplateEntity

### Inherited from (ModelFactory.this)#EntityImpl

### Inherited from Entity

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd from(ModelFactory.this)#NoDocTemplateImpl to any2stringadd[(ModelFactory.this)#NoDocTemplateImpl]

### Inherited by implicit conversion StringFormat from(ModelFactory.this)#NoDocTemplateImpl to StringFormat[(ModelFactory.this)#NoDocTemplateImpl]

### Inherited by implicit conversion Ensuring from(ModelFactory.this)#NoDocTemplateImpl to Ensuring[(ModelFactory.this)#NoDocTemplateImpl]

### Inherited by implicit conversion ArrowAssoc from(ModelFactory.this)#NoDocTemplateImpl to ArrowAssoc[(ModelFactory.this)#NoDocTemplateImpl]

### Ungrouped