summaryrefslogtreecommitdiff
path: root/src/scaladoc/scala/tools/nsc/doc/doclet/Indexer.scala
blob: 0cdd47182f67240c2f5425c8d8ea6ec563373183 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package scala.tools.nsc
package doc
package doclet

/** A `Generator` may implement the `Indexer` trait to gain access to pre-calculated indexing information */
trait Indexer extends Generator with Universer {

  protected var indexField: Index = null

  def index: Index = indexField

  def setIndex(i: Index) {
    assert(indexField == null)
    indexField = i
  }

  checks += { () =>
    indexField != null
  }

}