package odig

  1. Overview
  2. Docs
Lookup documentation of installed OCaml packages

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; LicenseRef-ParaType-Free-Font-License; LicenseRef-DejaVu-fonts License Edit opam file Versions (2)

Authors

  1. T
    The odig programmers

Maintainers

  1. Daniel Bünzli

Sources

odig-0.1.0.tbz
sha512=acabe752f5010900e9fe024321d6e34cc07f395ebd18f015a00b88c4c6482645b591a83a3f088f110adaf83e062551feb800a1dbca7646cce305eb3f542cfa41

doc/odig_support/Odig_support/Doc_cobj/index.html

Module Odig_support.Doc_cobjSource

Lookup package API documention compilation objects.

The compilation objects relevant for documentation are looked up according to the following rules:

  1. Packages denote which compilation units should appear in the docs by installing their cmi file.
  2. For each of these files odig looks, in the same directory, first for a corresponding cmti file then if missing for a cmt file, then if none of these exist the cmi file.
  3. For cmti or cmt files which have no corresponding cmi file odig collects them and deems them to be hidden (odoc will be called with the --hidden option).

Documentation compilation objects

Sourcetype kind =
  1. | Cmi
  2. | Cmti
  3. | Cmt

The type for kinds of documentation compilation object.

Sourcetype t

The type for documentation compilation objects.

Sourceval path : t -> B0_std.Fpath.t

path cobj is the path to cobj.

Sourceval kind : t -> kind

kind cobj is the kind of cobj.

Sourceval modname : t -> string

modname cobj is the module name of cobj (as determined from the filename).

Sourceval pkg : t -> Pkg.t

pkg cobj is the package of cobj.

Sourceval hidden : t -> bool

hidden cobj is true if odoc must compile cobj with the --hidden option.

Sourceval don't_list : t -> bool

don't_list cobj is true if cobj should not appear in module indexes.

Queries

Sourceval of_pkg : Pkg.t -> t list

of_pkg pkg are the compilation objects of pkg that are useful for documentation generation.

Sourceval by_modname : ?init:t list B0_std.String.Map.t -> t list -> t list B0_std.String.Map.t

by_modname ~init cobjs indexes cobjs by module name and adds them to init (defaults to String.Map.empty).