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/IndexBuild/index.html

Module IndexBuildSource

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

Sourceval load : qualify:bool -> 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.

Sourceval add_file : qualify:bool -> IndexTypes.t -> string -> IndexTypes.t

Load a single file into a trie

Sourceval 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.

Sourceval fully_open_module : ?cleanup_path:bool -> qualify: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)

Sourceval 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.