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.1.tar.gz
md5=299f0dd7de61cc7a7afc70cec7ad7fab
sha512=dfbf205351aa463530d8831527fb1c7f6564c88aaff050d6f36cb3a71e26ff4df3425e4adda86923f037dffacd316d5ad5009a64845265cdd9b6b25af34287a7

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

Module IndexBuild

This module contains the function to create our lazy data structure from cmi, cmt and cmti files or from whole directories

val load : string list -> IndexTypes.t

Build the trie from a list of include directories. They will be scanned for .cmi and .cmt files to complete on module names, and the contents of these files will be lazily read whenever needed.

val add_file : IndexTypes.t -> string -> IndexTypes.t

Load a single file into a trie

val open_module : ?cleanup_path:bool -> IndexTypes.t -> string list -> IndexTypes.t

Consider the module at the given path as opened, i.e. rebind its contents at the root of the trie. If cleanup_path, also change its contents to refer to the new path.

val fully_open_module : ?cleanup_path:bool -> IndexTypes.t -> string list -> IndexTypes.t

Same as open_module, but tries to open even the elements that are not in the external interface (this needs a cmt to be present)

val alias : ?cleanup_path:bool -> IndexTypes.t -> string list -> string list -> IndexTypes.t

alias t origin alias binds at alias the contents found at origin. If ~cleanup_path is set, also change its contents to refer to the new path.