summaryrefslogtreecommitdiff
path: root/src/compiler/scala/tools/nsc/doc/model/TypeEntity.scala
blob: 5e18e0d9bcd8ef0330cc757ed3d60255f8e3ab29 (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
/* NSC -- new Scala compiler
 * Copyright 2007-2009 LAMP/EPFL
 * @author  Manohar Jonnalagedda
 */

package scala.tools.nsc
package doc
package model

import scala.collection._

abstract class TypeEntity {

  /** A string reprsentation of this type. */
  def name: String

  /** Maps which parts of this type's name reference other 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, (TemplateEntity, Int)]

  override def toString =
    name

}