package odoc

  1. Overview
  2. Docs
package odoc
Legend:
Library
Module
Module type
Parameter
Class
Class type

Modules

module Module : sig ... end
module FunctorParameter : sig ... end

Modules Types

module ModuleType : sig ... end
module ModuleSubstitution : sig ... end
module ModuleTypeSubstitution : sig ... end

Signatures

module Signature : sig ... end
module Open : sig ... end

Includes

module Include : sig ... end

Type Declarations

module TypeDecl : sig ... end

Type extensions

module Extension : sig ... end
module Exception : sig ... end

Values

module Value : sig ... end

Classes

module Class : sig ... end

Class Types

module ClassType : sig ... end

Class Signatures

module ClassSignature : sig ... end

Methods

module Method : sig ... end

Instance variables

module InstanceVariable : sig ... end

Type expressions

module TypeExpr : sig ... end

Compilation units

module Compilation_unit : sig ... end
module Page : sig ... end
val umty_of_mty : ModuleType.expr -> ModuleType.U.expr option
val extract_signature_doc : Signature.t -> Comment.docs

Query the top-comment of a signature. This is s.doc most of the time with an exception for signature starting with an inline includes.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct