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.2.2.tar.gz
md5=f8850fe552b1a8d29d5e4cf9a2d8a54a
sha512=2165da986f65b5aeac83abd3bed9b8d9a8d2d7e54ef8a7a6d051c0a2ccb6d8ce8ff37104037f8c8a4c9c9accbe2c6fced497cdbd6ea14ff063fabba9c5e54260

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

Module IndexTypes

type ty = Outcometree.out_sig_item

Internal representation of types

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

The type of files we get our data from

type 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

and 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

type t = (char, info) IndexTrie.t

Lazy trie structure holding the info on all identifiers

exception Bad_format of string