api

Type Members

1. trait CommonApi extends AnyRef

   

   Methods exposed by both APIs.

2. sealed trait Definition extends AnyRef

   

3. case class DocComment(body: String, attributes: List[(String, String)]) extends Product with Serializable

   

4. case class FingerprintTerm(variance: Variance, tpe: String) extends Product with Serializable

   

5. case class IndexBusy(indexedModules: Seq[Module], indexErrors: Seq[String]) extends IndexStatus with Product with Serializable

   

6. case class IndexJob(module: Module, artifactPath: String, docUrlPrefix: Option[String]) extends Product with Serializable

   

7. case class IndexReady(indexedModules: Seq[Module], indexErrors: Seq[String]) extends IndexStatus with Product with Serializable

   

8. sealed trait IndexStatus extends AnyRef

   

9. case class Module(organization: String, name: String, revision: String) extends Product with Serializable

   

10. case class Result[E](entity: E, score: Float, explanation: Option[String]) extends Product with Serializable

    

11. trait ScapsApi extends CommonApi

    

    The main API exposed to search engine users.

    The main API exposed to search engine users.

    All exposed methods are considered safe and should not lead to erroneous behavior when missused.

12. trait ScapsControlApi extends CommonApi

    

    A control API which access may be limited to local users.

    A control API which access may be limited to local users.

    The exposed methods may destroy the index or will take a long time to process.

13. case class TypeDef(name: String, typeParameters: List[TypeParameter], comment: String = "", module: Module = Module.Unknown, typeFrequency: Map[Variance, Float] = Map()) extends Definition with Product with Serializable

    

14. case class TypeParameter(name: String, variance: Variance, lowerBound: TypeRef = TypeRef.Nothing(Covariant), upperBound: TypeRef = TypeRef.Any(Contravariant)) extends Product with Serializable

    

15. case class TypeRef(name: String, variance: Variance, args: List[TypeRef], isTypeParam: Boolean = false) extends Product with Serializable

    

16. case class ValueDef(name: String, typeParameters: List[TypeParameter], tpe: TypeRef, comment: DocComment, flags: Set[Flag] = Set(), module: Module = Module.Unknown, docLink: Option[String] = None) extends Definition with Product with Serializable

    

17. sealed trait Variance extends AnyRef

    

18. case class ViewDef(from: TypeRef, to: TypeRef, distance: Float, definingEntityName: String = "", module: Module = Module.Unknown) extends Definition with Product with Serializable