scala.tools.nsc.doc

# model

#### package model

Content Hierarchy Learn more about scaladoc diagrams
Visibility

1. Public
2. All

### 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 BoundedTypeParamConstraint extends TypeParamConstraint

5. #### trait Class extends MemberTemplateEntity

   A class template.

6. #### trait CommentFactory extends CommentFactoryBase

   The comment parser transforms raw comment strings into `Comment` objects.

7. #### trait Constraint extends AnyRef

   A trait that encapsulates a constraint necessary for implicit conversion

8. #### trait Constructor extends NonTemplateMemberEntity

   A constructor of a class.

9. #### trait Def extends NonTemplateMemberEntity with HigherKinded

   A method (`def`) of a template.

10. #### trait DocTemplateEntity extends MemberTemplateEntity

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

11. #### trait Entity extends AnyRef

    An entity in a Scaladoc universe.

12. #### trait EqualTypeParamConstraint extends TypeParamConstraint

13. #### trait HigherKinded extends AnyRef

    An entity that is parameterized by types

14. #### trait ImplicitConversion extends AnyRef

    A trait that signals the member results from an implicit conversion

15. #### trait ImplicitInScopeConstraint extends Constraint

    A constraint involving a type parameter which must be in scope

16. #### 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 a 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 converion error

17. #### trait KnownTypeClassConstraint extends TypeClassConstraint

18. #### trait LowerBoundedTypeParamConstraint extends TypeParamConstraint

19. #### trait MemberEntity extends Entity

    An entity that is a member of a template.

20. #### trait MemberLookup extends MemberLookupBase

    This trait extracts all required information for documentation from compilation units

21. #### 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

22. #### class ModelFactory extends AnyRef

    This trait extracts all required information for documentation from compilation units

23. #### trait ModelFactoryImplicitSupport extends AnyRef

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

24. #### trait ModelFactoryTypeSupport extends AnyRef

    This trait extracts all required information for documentation from compilation units

25. #### 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.

26. #### trait NonTemplateMemberEntity extends MemberEntity

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

27. #### trait Object extends MemberTemplateEntity

    An object template.

28. #### trait Package extends DocTemplateEntity

    A package template.

29. #### trait ParameterEntity extends AnyRef

    A parameter to an entity.

30. #### case class PrivateInInstance () extends Visibility with Product with Serializable

    The visibility of `private[this]` members.

31. #### case class PrivateInTemplate (owner: TemplateEntity) extends Visibility with Product with Serializable

    The visibility of `private[owner]` members.

32. #### case class ProtectedInInstance () extends Visibility with Product with Serializable

    The visibility of `protected[this]` members.

33. #### case class ProtectedInTemplate (owner: TemplateEntity) extends Visibility with Product with Serializable

    The visibility of `protected[owner]` members.

34. #### case class Public () extends Visibility with Product with Serializable

    The visibility of public members.

35. #### trait RootPackage extends Package

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

36. #### trait TemplateEntity extends Entity

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

37. #### trait Trait extends MemberTemplateEntity

    A trait template.

38. #### abstract class TreeEntity extends AnyRef

    A fragment of code.

39. #### 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.

40. #### trait TypeClassConstraint extends ImplicitInScopeConstraint with TypeParamConstraint

41. #### abstract class TypeEntity extends AnyRef

    A type.

42. #### trait TypeParam extends ParameterEntity with HigherKinded

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

43. #### trait TypeParamConstraint extends Constraint

    A constraint involving a type parameter

44. #### trait UpperBoundedTypeParamConstraint extends TypeParamConstraint

45. #### trait Val extends NonTemplateMemberEntity

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

46. #### trait ValueArgument extends AnyRef

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

47. #### trait ValueParam extends ParameterEntity

    A value parameter to a constructor or method.

48. #### sealed trait Visibility extends AnyRef

    An type that represents visibility of members.

### Value Members

1. #### object Entity

2. #### object IndexModelFactory

3. #### object MemberEntity

4. #### package diagram

### Ungrouped