To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
-
bigarray
-
dynlink
-
ocamlbytecomp
-
ocamlcommon
-
ocamlmiddleend
-
ocamloptcomp
-
odoc_info
-
raw_spacetime_lib
-
-
stdlib
-
str
-
threads
-
unix
Library
Module
Module type
Parameter
Class
Class type
Interface to the information collected in source files.
type ref_kind = Odoc_types.ref_kind = | RK_module| RK_module_type| RK_class| RK_class_type| RK_value| RK_type| RK_extension| RK_exception| RK_attribute| RK_method| RK_section of text| RK_recfield| RK_const
The different kinds of element references.
and text_element = Odoc_types.text_element = | Raw of string(*Raw text.
*)| Code of string(*The string is source code.
*)| CodePre of string(*The string is pre-formatted source code.
*)| Verbatim of string(*String 'as is'.
*)| Bold of text(*Text in bold style.
*)| Italic of text(*Text in italic.
*)| Emphasize of text(*Emphasized text.
*)| Center of text(*Centered text.
*)| Left of text(*Left alignment.
*)| Right of text(*Right alignment.
*)| List of text list(*A list.
*)| Enum of text list(*An enumerated list.
*)| Newline(*To force a line break.
*)| Block of text(*Like html's block quote.
*)| Title of int * string option * text(*Style number, optional label, and text.
*)| Latex of string(*A string for latex.
*)| Link of string * text(*A reference string and the link text.
*)| Ref of string * ref_kind option * text option(*A reference to an element. Complete name and kind. An optional text can be given to display this text instead of the element name.
*)| Superscript of text(*Superscripts.
*)| Subscript of text(*Subscripts.
*)| Module_list of string list(*The table of the given modules with their abstract.
*)| Index_list(*The links to the various indexes (values, types, ...)
*)| Custom of string * text(*to extend {foo syntax
*)| Target of string * string(*(target, code) : to specify code specific to a target format
*)
and text = text_element listA text is a list of text_element. The order matters.
The different forms of references in @see tags.
Raised when parsing string to build a Odoc_info.text structure. (line, char, string)
type param = string * textParameter name and description.
type raised_exception = string * textRaised exception name and description.
type info = Odoc_types.info = {i_desc : text option;(*The description text.
*)i_authors : string list;(*The list of authors in @author tags.
*)i_version : string option;(*The string in the @version tag.
*)i_sees : see list;(*The list of @see tags.
*)i_since : string option;(*The string in the @since tag.
*)i_before : (string * text) list;(*the version number and text in @before tag
*)i_deprecated : text option;(*The description text of the @deprecated tag.
*)i_params : param list;(*The list of parameter descriptions.
*)i_raised_exceptions : raised_exception list;(*The list of raised exceptions.
*)i_return_value : text option;(*The description text of the return value.
*)i_custom : (string * text) list;(*A text associated to a custom @-tag.
*)
}Information in a special comment
- before 3.12.0
@before information was not present.