package ocp-index

You can search for identifiers within the package.

in-package search v0.2.0

Lightweight completion and documentation browsing for OCaml libraries

Install

Dune Dependency

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

Authors

Maintainers

L

louis.gesbert@ocamlpro.com

Sources

1.3.3.tar.gz

md5=738dd32765ce0b6b6423620cc62b7db9

sha512=6360240c951ac64baf9b3736c9a37c41a5ac8c5ddf52e723019fb5ef294e786e245712fd88f408bd8f6881d8741ab152872181062acd81443eec07d1d703e85a

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

Module `IndexBuild`Source

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

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

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

Load a single file into a trie

Source

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.

Source

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)

Source

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.

package ocp-index

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module IndexBuildSource

Module `IndexBuild`Source