package ocp-index

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

Install

Dune Dependency

Authors

Maintainers

Sources

1.3.5.tar.gz
md5=0bc13dfb30c5dece280fd2496ca57cea
sha512=19f564a98cba92c26ebb32d46b7eb9eb60374977760c97b62c1ffa4f568d0a8e563df4a6bbc3ad7ca7760548c7c57465d1eb30ab5f3138c6fb1084d68c0cc0b0

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
OCaml

Innovation. Community. Security.