package ocp-index

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

1.4.0.tar.gz
md5=7224ae09fd740ce7ab7b059666e08e4b
sha512=92e6c32ae1b953ae0928e48e09dc3238a43b87165130ec85f9e73c71ea6ce38f51bc3e39768bae0eb76d06a945767a4dcbabd3a111ccf45f37b182aa16b304ad

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

Module IndexScopeSource

Sourcetype t
Sourceval empty : t

The empty scope

Sourcetype env =
  1. | Alias of string * string list
  2. | Open of string list

The type of gathered information within a scope

Sourceval from_dot_merlin : string -> env list

From a directory name, look for a .merlin file and check for open flags in it

Sourceval read : ?line:int -> ?column:int -> in_channel -> t

Compute the environment from an input channel, at an optional position or at EOF

Sourceval read_string : string -> t

Compute the environment from a string

Sourceval fold : ('a -> t -> Approx_lexer.token -> (int * int * int) -> 'a) -> 'a -> ?init:env list -> ?stop:(Lexing.position -> bool) -> in_channel -> 'a

Lower-level function for processing on the environment at every token. The position is given in the form (line, column, length)

Sourceval fold_string : ('a -> t -> Approx_lexer.token -> (int * int * int) -> 'a) -> 'a -> ?init:env list -> ?stop:(Lexing.position -> bool) -> string -> 'a

The same from a string

Sourceval to_list : t -> env list

Returns the env declarations in scope t, in source file order

OCaml

Innovation. Community. Security.