Type Members

1.  trait AbstractType extends MemberTemplateEntity with HigherKinded

   An abstract type member of a template.

2.  trait AliasType extends MemberTemplateEntity with HigherKinded

   An type alias of a template.

3.  trait Annotation extends Entity

   An annotation to an entity.

4.  trait AnnotationClass extends Class

   An annotation template.

   An annotation template. Any class which extends scala.annotation.Annotation

5.  trait BoundedTypeParamConstraint extends TypeParamConstraint
6.  trait Class extends MemberTemplateEntity

   A class template.

7.  trait CommentFactory extends CommentFactoryBase

   The comment parser transforms raw comment strings into Comment objects.

   The comment parser transforms raw comment strings into Comment objects. Call parse to run the parser. Note that the parser is stateless and should only be built once for a given Scaladoc run.

8.  sealed trait Constraint extends AnyRef

   A trait that encapsulates a constraint necessary for implicit conversion

9.  trait Constructor extends NonTemplateMemberEntity

   A constructor of a class.

10.  trait Def extends NonTemplateMemberEntity with HigherKinded

    A method (def) of a template.

11.  trait DocTemplateEntity extends MemberTemplateEntity

    A template (class, trait, object or package) for which documentation is available.

    A template (class, trait, object or package) for which documentation is available. Only templates for which a source file is given are documented by Scaladoc.

12.  trait Entity extends AnyRef

    An entity in a Scaladoc universe.

    An entity in a Scaladoc universe. Entities are declarations in the program and correspond to symbols in the compiler. Entities model the following Scala concepts:

    • classes and traits;
    • objects and package;
    • constructors;
    • methods;
    • values, lazy values, and variables;
    • abstract type members and type aliases;
    • type and value parameters;
    • annotations.
13.  trait EqualTypeParamConstraint extends TypeParamConstraint
14.  trait HigherKinded extends AnyRef

    An entity that is parameterized by types

15.  trait ImplicitConversion extends AnyRef

    A trait that signals the member results from an implicit conversion

16.  trait ImplicitInScopeConstraint extends Constraint

    A constraint involving a type parameter which must be in scope

17.  trait ImplicitMemberShadowing extends AnyRef

    Shadowing captures the information that the member is shadowed by some other members There are two cases of implicitly added member shadowing: 1) shadowing from an original class member (the class already has that member) in this case, it won't be possible to call the member directly, the type checker will fail attempting to adapt the call arguments (or if they fit it will call the original class method) 2) shadowing from other possible implicit conversions () this will result in an ambiguous implicit conversion error

18.  trait KnownTypeClassConstraint extends TypeClassConstraint
19.  trait LowerBoundedTypeParamConstraint extends TypeParamConstraint
20.  trait MemberEntity extends Entity

    An entity that is a member of a template.

    An entity that is a member of a template. All entities, including templates, are member of another entity except for parameters and annotations. Note that all members of a template are modelled, including those that are inherited and not declared locally.

21.  trait MemberLookup extends MemberLookupBase

    This trait extracts all required information for documentation from compilation units

22.  trait MemberTemplateEntity extends TemplateEntity with MemberEntity with HigherKinded

    An inherited template that was not documented in its original owner - example: in classpath: trait T { class C } -- T (and implicitly C) are not documented in the source: trait U extends T -- C appears in U as a MemberTemplateImpl -- that is, U has a member for it but C doesn't get its own page

23.  class ModelFactory extends AnyRef

    This trait extracts all required information for documentation from compilation units

24.  trait ModelFactoryImplicitSupport extends AnyRef

    This trait finds implicit conversions for a class in the default scope and creates scaladoc entries for each of them.

    This trait finds implicit conversions for a class in the default scope and creates scaladoc entries for each of them.

    Let's take this as an example:

    object Test {
      class A
    
      class B {
        def foo = 1
      }
    
      class C extends B {
        def bar = 2
        class D
      }
    
      implicit def conv(a: A) = new C
    }

    Overview: - scaladoc-ing the above classes, A will get two more methods: foo and bar, over its default methods - the nested classes (specifically D above), abstract types, type aliases and constructor members are not added to A (see makeMember0 in ModelFactory, last 3 cases) - the members added by implicit conversion are always listed under the implicit conversion, not under the class they actually come from (foo will be listed as coming from the implicit conversion to C instead of B) - see definitionName in MemberImpl

    Internals: TODO: Give an overview here

25.  trait ModelFactoryTypeSupport extends AnyRef

    This trait extracts all required information for documentation from compilation units

26.  trait NoDocTemplate extends TemplateEntity

    A template (class, trait, object or package) which is referenced in the universe, but for which no further documentation is available.

    A template (class, trait, object or package) which is referenced in the universe, but for which no further documentation is available. Only templates for which a source file is given are documented by Scaladoc.

27.  trait NonTemplateMemberEntity extends MemberEntity

    A non-template member (method, value, lazy value, variable, constructor, alias type, and abstract type).

28.  trait Object extends MemberTemplateEntity

    An object template.

29.  trait Package extends DocTemplateEntity

    A package template.

    A package template. A package is in the universe if it is declared as a package object, or if it contains at least one template.

30.  trait ParameterEntity extends AnyRef

    A parameter to an entity.

31.  case class PrivateInInstance() extends Visibility with Product with Serializable

    The visibility of private[this] members.

32.  case class PrivateInTemplate(owner: Option[TypeEntity]) extends Visibility with Product with Serializable

    The visibility of private[owner] members.

    The visibility of private[owner] members. An unqualified private members is encoded with owner equal to the members's inTemplate.

33.  case class ProtectedInInstance() extends Visibility with Product with Serializable

    The visibility of protected[this] members.

34.  case class ProtectedInTemplate(owner: Option[TypeEntity]) extends Visibility with Product with Serializable

    The visibility of protected[owner] members.

    The visibility of protected[owner] members. An unqualified protected members is encoded with owner equal to None. Note that whilst the member is visible in any template owned by owner, it is only visible in subclasses of the member's inTemplate.

35.  case class Public() extends Visibility with Product with Serializable

    The visibility of public members.

36.  trait RootPackage extends Package

    The root package, which contains directly or indirectly all members in the universe.

    The root package, which contains directly or indirectly all members in the universe. A universe contains exactly one root package.

37.  trait TemplateEntity extends Entity

    A template, which is either a class, trait, object or package.

    A template, which is either a class, trait, object or package. Depending on whether documentation is available or not, the template will be modeled as a [scala.tools.nsc.doc.model.NoDocTemplate] or a [scala.tools.nsc.doc.model.DocTemplateEntity].

38.  trait Trait extends MemberTemplateEntity

    A trait template.

39.  abstract class TreeEntity extends AnyRef

    A fragment of code.

40.  trait TreeFactory extends AnyRef

    The goal of this trait is, using makeTree, to browse a tree to 1- have the String of the complete tree (tree.expression) 2- fill references to create hyperlinks later in html.pageTemplate

    The goal of this trait is, using makeTree, to browse a tree to 1- have the String of the complete tree (tree.expression) 2- fill references to create hyperlinks later in html.pageTemplate

    It is applied in ModelFactory => makeTree

41.  trait TypeClassConstraint extends ImplicitInScopeConstraint with TypeParamConstraint
42.  abstract class TypeEntity extends AnyRef

    A type.

    A type. Note that types and templates contain the same information only for the simplest types. For example, a type defines how a template's type parameters are instantiated (as in List[Cow]), what the template's prefix is (as in johnsFarm.Cow), and supports compound or structural types.

43.  trait TypeParam extends ParameterEntity with HigherKinded

    A type parameter to a class, trait, or method.

44.  sealed trait TypeParamConstraint extends Constraint

    A constraint involving a type parameter

45.  trait UpperBoundedTypeParamConstraint extends TypeParamConstraint
46.  trait Val extends NonTemplateMemberEntity

    A value (val), lazy val (lazy val) or variable (var) of a template.

47.  trait ValueArgument extends AnyRef

    A value that is passed as an argument to a value parameter.

48.  trait ValueParam extends ParameterEntity

    A value parameter to a constructor or method.

49.  sealed trait Visibility extends AnyRef

    An type that represents visibility of members.