package ocp-index

  1. Overview
  2. Docs
Lightweight completion and documentation browsing for OCaml libraries

Install 

dune-project
 Dependency

www.typerex.org Readme Changelog Edit opam file Versions (14)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

1.3.6.tar.gz
md5=b4d5f80b168a31146df5eb30613cc1b9
sha512=f8f97e846e37473a77636518ceefafa72a62f26ed9e7fc65ee4625498bcc1797187e895d903dfb2e874e93889956ee02b2e1f6f90c61717107db8e96d388d65a

doc/ocp-index.lib/IndexTypes/index.html

Module IndexTypesSource

Internal representation of types

Sourcetype orig_file =
  1. | Cmt of string
  2. | Cmti of string
  3. | Cmi of string

The type of files we get our data from

Sourcetype info = {
  1. path : string list;
  2. orig_path : string list;
  3. kind : kind;
  4. name : string;
  5. ty : ty option;
  6. loc_sig : Location.t Lazy.t;
  7. loc_impl : Location.t Lazy.t;
  8. doc : string option Lazy.t;
  9. file : orig_file;
}

Contains the information on a given identifier

Sourceand kind =
  1. | Type
  2. | Value
  3. | Exception
  4. | OpenType
  5. | Field of info
  6. | Variant of info
  7. | Method of info
  8. | Module
  9. | ModuleType
  10. | Class
  11. | ClassType
  12. | Keyword

The kind of elements that can be stored in the trie

Sourcetype t = (char, info) IndexTrie.t

Lazy trie structure holding the info on all identifiers

Sourceexception Bad_format of string