package ocp-browser

  1. Overview
  2. Docs
Console browser for the documentation of installed OCaml libraries

Install

Dune Dependency

www.typerex.org Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (15)

Authors

  1. L
    Louis Gesbert
  2. Gabriel Radanne

Maintainers

  1. L
    louis.gesbert@ocamlpro.com

Sources

1.1.9.tar.gz
md5=e66ce96958cc87c724e9163feaaf769f
sha512=3ecc6b5208db5be23edb2cca66324aad0768644e2a08a9fb0294f920a53ae22af46c5f6cd4768f61d1c532b3110a99873b4c5139fc2585b3b70e41c8e577b543

Description

ocp-browser is a ncurses-like interface that allows to easily browse the interfaces and documentation of all installed OCaml modules.

Tags

org:ocamlpro org:typerex

Published: 09 Mar 2019

README

README.md

ocp-index is a light-weight tool and library providing easy access to the information contained in your OCaml cmi/cmt/cmti files. It can be used to provide features like library interface browsing, auto-completion, show-type and goto-source.

This source tree builds:

  • ocp-index.lib, the engine as a library

  • the ocp-index command-line tool

  • the ocp-grep command-line tool, that can search code for a given qualified OCaml ident (including uses after opens, etc.)

  • the ocp-browser tool, which is a browser for installed OCaml APIs on the terminal

The first tree are part of opam package ocp-index, and the latter is in its own ocp-browser package.

ocp-index is part of TypeRex, developed and maintained by OCamlPro. Documentation to install and use this tool is available on http://www.typerex.org/ocp-index.html

It is released under LGPL v3 with linking exception.

Dependencies (6)

  1. lambda-term < "2.0"
  2. cmdliner
  3. ocp-index = version
  4. dune >= "1.0"
  5. ocp-pp build
  6. ocaml >= "4.02.0"

Dev Dependencies

None

Used by

None

Conflicts

None