package odoc

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Documentation Generator

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (4)

Authors

Maintainers

Sources

odoc-3.1.0.tbz

sha256=355b3cfff4934903cbaed8b51ce35e333e8609932d230294200a9f2d42ffa914

sha512=f78318d0a16164a9cd16ee02f611c2e00d32b772fe38e992d6db6ec94b1c00cd9c377fbfe64031b8f245e57b2f3aac9364108327e7f1693533ddcff94c476e05

doc/odoc.xref2/Odoc_xref2/Component/index.html

Module `Odoc_xref2.Component`Source

Component module

Sourcemodule ModuleMap : Map.S with type key = Ident.module_

Sourcemodule TypeMap : Map.S with type key = Ident.type_

Sourcemodule ModuleTypeMap : Map.S with type key = Ident.module_type

Sourcemodule ValueMap : Map.S with type key = Ident.value

Sourcemodule IdentMap : Map.S with type key = Ident.any

Sourcemodule Delayed : sig ... end

Delayed is a bit like Lazy.t but may in the future offer the chance to peek inside to be able to optimize the calculation

Sourcemodule Opt : sig ... end

Components

The modules/types here are very similar to those in Odoc_model.Lang, in most cases the only difference being that we have Idents (which are local) rather than Identifiers (which are global), Cpaths instead of Paths, and Cfrags rather than Fragments. All of these are to support the use of local idents.

Note that we still use global References rather than local ones - this is because at the point these components are being used all the references are unresolved, and hence do not contain any resolved global identifiers. When resolving references, we construct paths in parallel, which also helps avoid the need for local references.

These idents of items are kept outside of the types themselves in order to help with laziness.

There are a few other minor differences:

Signatures keep track of removed items. These items are removed during destructive substitution.

Sourcemodule Module : sig ... end

Sourcemodule ModuleSubstitution : sig ... end

Sourcemodule ModuleTypeSubstitution : sig ... end

Sourcemodule TypeExpr : sig ... end

Sourcemodule Extension : sig ... end

Sourcemodule Exception : sig ... end

Sourcemodule FunctorParameter : sig ... end

Sourcemodule ModuleType : sig ... end

Sourcemodule TypeDecl : sig ... end

Sourcemodule Signature : sig ... end

Sourcemodule Open : sig ... end

Sourcemodule Include : sig ... end

Sourcemodule Value : sig ... end

Sourcemodule Class : sig ... end

Sourcemodule ClassType : sig ... end

Sourcemodule ClassSignature : sig ... end

Sourcemodule Method : sig ... end

Sourcemodule InstanceVariable : sig ... end

Sourcemodule Substitution : sig ... end

Sourcemodule CComment : sig ... end

Sourcemodule Label : sig ... end

Sourcemodule Element : sig ... end

Sourcemodule Fmt : sig ... end

Formatting functions for components

Sourcemodule Of_Lang : sig ... end

Sourceval module_of_functor_argument : FunctorParameter.parameter -> Module.t

Sourceval extract_signature_doc : Signature.t -> CComment.docs

On This Page

Components