summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/model/TypeEntity.scala
blob: e4a053e1156f8a216220cf28e699d1ac9838a506 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/* NSC -- new Scala compiler
 * Copyright 2007-2013 LAMP/EPFL
 * @author  Manohar Jonnalagedda
 */

package scala.tools.nsc
package doc
package model

import scala.collection._

/** 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. */
abstract class TypeEntity {

  /** The human-readable representation of this type. */
  def name: String

  /** Maps which parts of this type's name reference entities. The map is indexed by the position of the first
    * character that reference some entity, and contains the entity and the position of the last referenced
    * character. The referenced character ranges do not to overlap or nest. The map is sorted by position. */
  def refEntity: SortedMap[Int, (LinkTo, Int)]

  /** The human-readable representation of this type. */
  override def toString = name
}