mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-18 16:46:41 -05:00
14 lines
No EOL
53 KiB
HTML
14 lines
No EOL
53 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Odoc_info (ocaml.Odoc_info)</title><link rel="stylesheet" href="../../_odoc-theme/odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../index.html">ocaml</a> » Odoc_info</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info</span></code></h1><p>Interface to the information collected in source files.</p></header><nav class="odoc-toc"><ul><li><a href="#getting-strings-from-values">Getting strings from values</a></li><li><a href="#miscellaneous-functions">Miscellaneous functions</a></li><li><a href="#some-global-variables">Some global variables</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-ref_kind"><a href="#type-ref_kind" class="anchor"></a><code><span><span class="keyword">type</span> ref_kind</span><span> = <a href="../Odoc_types/index.html#type-ref_kind">Odoc_types.ref_kind</a></span><span> = </span></code><ol><li id="type-ref_kind.RK_module" class="def variant constructor anchored"><a href="#type-ref_kind.RK_module" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_module</span></span></code></li><li id="type-ref_kind.RK_module_type" class="def variant constructor anchored"><a href="#type-ref_kind.RK_module_type" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_module_type</span></span></code></li><li id="type-ref_kind.RK_class" class="def variant constructor anchored"><a href="#type-ref_kind.RK_class" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_class</span></span></code></li><li id="type-ref_kind.RK_class_type" class="def variant constructor anchored"><a href="#type-ref_kind.RK_class_type" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_class_type</span></span></code></li><li id="type-ref_kind.RK_value" class="def variant constructor anchored"><a href="#type-ref_kind.RK_value" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_value</span></span></code></li><li id="type-ref_kind.RK_type" class="def variant constructor anchored"><a href="#type-ref_kind.RK_type" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_type</span></span></code></li><li id="type-ref_kind.RK_extension" class="def variant constructor anchored"><a href="#type-ref_kind.RK_extension" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_extension</span></span></code></li><li id="type-ref_kind.RK_exception" class="def variant constructor anchored"><a href="#type-ref_kind.RK_exception" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_exception</span></span></code></li><li id="type-ref_kind.RK_attribute" class="def variant constructor anchored"><a href="#type-ref_kind.RK_attribute" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_attribute</span></span></code></li><li id="type-ref_kind.RK_method" class="def variant constructor anchored"><a href="#type-ref_kind.RK_method" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_method</span></span></code></li><li id="type-ref_kind.RK_section" class="def variant constructor anchored"><a href="#type-ref_kind.RK_section" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_section</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code></li><li id="type-ref_kind.RK_recfield" class="def variant constructor anchored"><a href="#type-ref_kind.RK_recfield" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_recfield</span></span></code></li><li id="type-ref_kind.RK_const" class="def variant constructor anchored"><a href="#type-ref_kind.RK_const" class="anchor"></a><code><span>| </span><span><span class="constructor">RK_const</span></span></code></li></ol></div><div class="spec-doc"><p>The different kinds of element references.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-text_element"><a href="#type-text_element" class="anchor"></a><code><span><span class="keyword">and</span> text_element</span><span> = <a href="../Odoc_types/index.html#type-text_element">Odoc_types.text_element</a></span><span> = </span></code><ol><li id="type-text_element.Raw" class="def variant constructor anchored"><a href="#type-text_element.Raw" class="anchor"></a><code><span>| </span><span><span class="constructor">Raw</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Raw text.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Code" class="def variant constructor anchored"><a href="#type-text_element.Code" class="anchor"></a><code><span>| </span><span><span class="constructor">Code</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The string is source code.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.CodePre" class="def variant constructor anchored"><a href="#type-text_element.CodePre" class="anchor"></a><code><span>| </span><span><span class="constructor">CodePre</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The string is pre-formatted source code.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Verbatim" class="def variant constructor anchored"><a href="#type-text_element.Verbatim" class="anchor"></a><code><span>| </span><span><span class="constructor">Verbatim</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>String 'as is'.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Bold" class="def variant constructor anchored"><a href="#type-text_element.Bold" class="anchor"></a><code><span>| </span><span><span class="constructor">Bold</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Text in bold style.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Italic" class="def variant constructor anchored"><a href="#type-text_element.Italic" class="anchor"></a><code><span>| </span><span><span class="constructor">Italic</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Text in italic.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Emphasize" class="def variant constructor anchored"><a href="#type-text_element.Emphasize" class="anchor"></a><code><span>| </span><span><span class="constructor">Emphasize</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Emphasized text.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Center" class="def variant constructor anchored"><a href="#type-text_element.Center" class="anchor"></a><code><span>| </span><span><span class="constructor">Center</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Centered text.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Left" class="def variant constructor anchored"><a href="#type-text_element.Left" class="anchor"></a><code><span>| </span><span><span class="constructor">Left</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Left alignment.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Right" class="def variant constructor anchored"><a href="#type-text_element.Right" class="anchor"></a><code><span>| </span><span><span class="constructor">Right</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Right alignment.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.List" class="def variant constructor anchored"><a href="#type-text_element.List" class="anchor"></a><code><span>| </span><span><span class="constructor">List</span> <span class="keyword">of</span> <span><a href="#type-text">text</a> list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A list.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Enum" class="def variant constructor anchored"><a href="#type-text_element.Enum" class="anchor"></a><code><span>| </span><span><span class="constructor">Enum</span> <span class="keyword">of</span> <span><a href="#type-text">text</a> list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>An enumerated list.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Newline" class="def variant constructor anchored"><a href="#type-text_element.Newline" class="anchor"></a><code><span>| </span><span><span class="constructor">Newline</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>To force a line break.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Block" class="def variant constructor anchored"><a href="#type-text_element.Block" class="anchor"></a><code><span>| </span><span><span class="constructor">Block</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Like html's block quote.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Title" class="def variant constructor anchored"><a href="#type-text_element.Title" class="anchor"></a><code><span>| </span><span><span class="constructor">Title</span> <span class="keyword">of</span> int * <span>string option</span> * <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Style number, optional label, and text.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Latex" class="def variant constructor anchored"><a href="#type-text_element.Latex" class="anchor"></a><code><span>| </span><span><span class="constructor">Latex</span> <span class="keyword">of</span> string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A string for latex.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Link" class="def variant constructor anchored"><a href="#type-text_element.Link" class="anchor"></a><code><span>| </span><span><span class="constructor">Link</span> <span class="keyword">of</span> string * <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A reference string and the link text.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Ref" class="def variant constructor anchored"><a href="#type-text_element.Ref" class="anchor"></a><code><span>| </span><span><span class="constructor">Ref</span> <span class="keyword">of</span> string * <span><a href="#type-ref_kind">ref_kind</a> option</span> * <span><a href="#type-text">text</a> option</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A reference to an element. Complete name and kind. An optional text can be given to display this text instead of the element name.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Superscript" class="def variant constructor anchored"><a href="#type-text_element.Superscript" class="anchor"></a><code><span>| </span><span><span class="constructor">Superscript</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Superscripts.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Subscript" class="def variant constructor anchored"><a href="#type-text_element.Subscript" class="anchor"></a><code><span>| </span><span><span class="constructor">Subscript</span> <span class="keyword">of</span> <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Subscripts.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Module_list" class="def variant constructor anchored"><a href="#type-text_element.Module_list" class="anchor"></a><code><span>| </span><span><span class="constructor">Module_list</span> <span class="keyword">of</span> <span>string list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The table of the given modules with their abstract.</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Index_list" class="def variant constructor anchored"><a href="#type-text_element.Index_list" class="anchor"></a><code><span>| </span><span><span class="constructor">Index_list</span></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The links to the various indexes (values, types, ...)</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Custom" class="def variant constructor anchored"><a href="#type-text_element.Custom" class="anchor"></a><code><span>| </span><span><span class="constructor">Custom</span> <span class="keyword">of</span> string * <a href="#type-text">text</a></span></code><div class="def-doc"><span class="comment-delim">(*</span><p>to extend {foo syntax</p><span class="comment-delim">*)</span></div></li><li id="type-text_element.Target" class="def variant constructor anchored"><a href="#type-text_element.Target" class="anchor"></a><code><span>| </span><span><span class="constructor">Target</span> <span class="keyword">of</span> string * string</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>(target, code) : to specify code specific to a target format</p><span class="comment-delim">*)</span></div></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-text"><a href="#type-text" class="anchor"></a><code><span><span class="keyword">and</span> text</span><span> = <span><a href="#type-text_element">text_element</a> list</span></span></code></div><div class="spec-doc"><p>A text is a list of <code>text_element</code>. The order matters.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-see_ref"><a href="#type-see_ref" class="anchor"></a><code><span><span class="keyword">type</span> see_ref</span><span> = <a href="../Odoc_types/index.html#type-see_ref">Odoc_types.see_ref</a></span><span> = </span></code><ol><li id="type-see_ref.See_url" class="def variant constructor anchored"><a href="#type-see_ref.See_url" class="anchor"></a><code><span>| </span><span><span class="constructor">See_url</span> <span class="keyword">of</span> string</span></code></li><li id="type-see_ref.See_file" class="def variant constructor anchored"><a href="#type-see_ref.See_file" class="anchor"></a><code><span>| </span><span><span class="constructor">See_file</span> <span class="keyword">of</span> string</span></code></li><li id="type-see_ref.See_doc" class="def variant constructor anchored"><a href="#type-see_ref.See_doc" class="anchor"></a><code><span>| </span><span><span class="constructor">See_doc</span> <span class="keyword">of</span> string</span></code></li></ol></div><div class="spec-doc"><p>The different forms of references in @see tags.</p></div></div><div class="odoc-spec"><div class="spec exception anchored" id="exception-Text_syntax"><a href="#exception-Text_syntax" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">Text_syntax</span> <span class="keyword">of</span> int * int * string</span></code></div><div class="spec-doc"><p>Raised when parsing string to build a <a href="#type-text"><code>Odoc_info.text</code></a> structure. <code>(line, char, string)</code></p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-see"><a href="#type-see" class="anchor"></a><code><span><span class="keyword">type</span> see</span><span> = <a href="#type-see_ref">see_ref</a> * <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>The information in a @see tag.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-param"><a href="#type-param" class="anchor"></a><code><span><span class="keyword">type</span> param</span><span> = string * <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>Parameter name and description.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-raised_exception"><a href="#type-raised_exception" class="anchor"></a><code><span><span class="keyword">type</span> raised_exception</span><span> = string * <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>Raised exception name and description.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-info"><a href="#type-info" class="anchor"></a><code><span><span class="keyword">type</span> info</span><span> = <a href="../Odoc_types/index.html#type-info">Odoc_types.info</a></span><span> = </span><span>{</span></code><ol><li id="type-info.i_desc" class="def record field anchored"><a href="#type-info.i_desc" class="anchor"></a><code><span>i_desc : <span><a href="#type-text">text</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The description text.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_authors" class="def record field anchored"><a href="#type-info.i_authors" class="anchor"></a><code><span>i_authors : <span>string list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The list of authors in @author tags.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_version" class="def record field anchored"><a href="#type-info.i_version" class="anchor"></a><code><span>i_version : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The string in the @version tag.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_sees" class="def record field anchored"><a href="#type-info.i_sees" class="anchor"></a><code><span>i_sees : <span><a href="#type-see">see</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The list of @see tags.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_since" class="def record field anchored"><a href="#type-info.i_since" class="anchor"></a><code><span>i_since : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The string in the @since tag.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_before" class="def record field anchored"><a href="#type-info.i_before" class="anchor"></a><code><span>i_before : <span><span>(string * <a href="#type-text">text</a>)</span> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>the version number and text in @before tag</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_deprecated" class="def record field anchored"><a href="#type-info.i_deprecated" class="anchor"></a><code><span>i_deprecated : <span><a href="#type-text">text</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The description text of the @deprecated tag.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_params" class="def record field anchored"><a href="#type-info.i_params" class="anchor"></a><code><span>i_params : <span><a href="#type-param">param</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The list of parameter descriptions.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_raised_exceptions" class="def record field anchored"><a href="#type-info.i_raised_exceptions" class="anchor"></a><code><span>i_raised_exceptions : <span><a href="#type-raised_exception">raised_exception</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The list of raised exceptions.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_return_value" class="def record field anchored"><a href="#type-info.i_return_value" class="anchor"></a><code><span>i_return_value : <span><a href="#type-text">text</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The description text of the return value.</p><span class="comment-delim">*)</span></div></li><li id="type-info.i_custom" class="def record field anchored"><a href="#type-info.i_custom" class="anchor"></a><code><span>i_custom : <span><span>(string * <a href="#type-text">text</a>)</span> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>A text associated to a custom @-tag.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Information in a special comment</p><ul class="at-tags"><li class="before"><span class="at-tag">before</span> <span class="value">3.12.0</span> <p>@before information was not present.</p></li></ul></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-location"><a href="#type-location" class="anchor"></a><code><span><span class="keyword">type</span> location</span><span> = <a href="../Odoc_types/index.html#type-location">Odoc_types.location</a></span><span> = </span><span>{</span></code><ol><li id="type-location.loc_impl" class="def record field anchored"><a href="#type-location.loc_impl" class="anchor"></a><code><span>loc_impl : <span><a href="../Location/index.html#type-t">Location.t</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>implementation location</p><span class="comment-delim">*)</span></div></li><li id="type-location.loc_inter" class="def record field anchored"><a href="#type-location.loc_inter" class="anchor"></a><code><span>loc_inter : <span><a href="../Location/index.html#type-t">Location.t</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>interface location</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Location of elements in implementation and interface files.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dummy_loc"><a href="#val-dummy_loc" class="anchor"></a><code><span><span class="keyword">val</span> dummy_loc : <a href="#type-location">location</a></span></code></div><div class="spec-doc"><p>A dummy location.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Name"><a href="#module-Name" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Name/index.html">Name</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation of element names.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Parameter"><a href="#module-Parameter" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Parameter/index.html">Parameter</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of method / function / class / module parameters.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Extension"><a href="#module-Extension" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Extension/index.html">Extension</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of extensions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Exception"><a href="#module-Exception" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Exception/index.html">Exception</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of exceptions.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Type"><a href="#module-Type" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Type/index.html">Type</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of types.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Value"><a href="#module-Value" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Value/index.html">Value</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of values, class attributes and class methods.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Class"><a href="#module-Class" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Class/index.html">Class</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of classes and class types.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Module"><a href="#module-Module" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Module/index.html">Module</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Representation and manipulation of modules and module types.</p></div></div><h3 id="getting-strings-from-values"><a href="#getting-strings-from-values" class="anchor"></a>Getting strings from values</h3><div class="odoc-spec"><div class="spec value anchored" id="val-reset_type_names"><a href="#val-reset_type_names" class="anchor"></a><code><span><span class="keyword">val</span> reset_type_names : <span>unit <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>This function is used to reset the names of type variables. It must be called when printing the whole type of a function, but not when printing the type of its parameters. Same for classes (call it) and methods and attributes (don't call it).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_variance"><a href="#val-string_of_variance" class="anchor"></a><code><span><span class="keyword">val</span> string_of_variance : <span><a href="Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">-></span></span> <span><span>(bool * bool)</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>string_of_variance t (covariant, invariant)</code> returns <code>"+"</code> if the given information means "covariant", <code>"-"</code> if it means "contravariant", orelse <code>""</code>, and always <code>""</code> if the given type is not an abstract type with no manifest (i.e. no need for the variance to be printed).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type_expr"><a href="#val-string_of_type_expr" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type_expr : <span><a href="../Types/index.html#type-type_expr">Types.type_expr</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string representing a Types.type_expr.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_class_params"><a href="#val-string_of_class_params" class="anchor"></a><code><span><span class="keyword">val</span> string_of_class_params : <span><a href="Class/index.html#type-t_class">Class.t_class</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to display the parameters of the given class, in the same form as the compiler.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type_list"><a href="#val-string_of_type_list" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type_list : <span>?par:bool <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><span><a href="../Types/index.html#type-type_expr">Types.type_expr</a> list</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string to represent the given list of types, with a given separator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type_param_list"><a href="#val-string_of_type_param_list" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type_param_list : <span><a href="Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string to represent the list of type parameters for the given type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type_extension_param_list"><a href="#val-string_of_type_extension_param_list" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type_extension_param_list : <span><a href="Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string to represent the list of type parameters for the given type extension.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_class_type_param_list"><a href="#val-string_of_class_type_param_list" class="anchor"></a><code><span><span class="keyword">val</span> string_of_class_type_param_list : <span><span><a href="../Types/index.html#type-type_expr">Types.type_expr</a> list</span> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string to represent the given list of type parameters of a class or class type, with a given separator.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_module_type"><a href="#val-string_of_module_type" class="anchor"></a><code><span><span class="keyword">val</span> string_of_module_type :
|
||
<span>?code:string <span class="arrow">-></span></span>
|
||
<span>?complete:bool <span class="arrow">-></span></span>
|
||
<span><a href="../Types/index.html#type-module_type">Types.module_type</a> <span class="arrow">-></span></span>
|
||
string</span></code></div><div class="spec-doc"><p>This function returns a string representing a <code>Types.module_type</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">complete</span> <p>indicates if we must print complete signatures or just <code>sig end</code>. Default is <code>false</code>.</p></li></ul><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">code</span> <p>if <code>complete = false</code> and the type contains something else than identificators and functors, then the given code is used.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_class_type"><a href="#val-string_of_class_type" class="anchor"></a><code><span><span class="keyword">val</span> string_of_class_type : <span>?complete:bool <span class="arrow">-></span></span> <span><a href="../Types/index.html#type-class_type">Types.class_type</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>This function returns a string representing a <code>Types.class_type</code>.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">complete</span> <p>indicates if we must print complete signatures or just <code>object end</code>. Default is <code>false</code>.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_text"><a href="#val-string_of_text" class="anchor"></a><code><span><span class="keyword">val</span> string_of_text : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Get a string from a text.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_info"><a href="#val-string_of_info" class="anchor"></a><code><span><span class="keyword">val</span> string_of_info : <span><a href="#type-info">info</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Get a string from an info structure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type"><a href="#val-string_of_type" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type : <span><a href="Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given type.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_record"><a href="#val-string_of_record" class="anchor"></a><code><span><span class="keyword">val</span> string_of_record : <span><span><a href="Type/index.html#type-record_field">Type.record_field</a> list</span> <span class="arrow">-></span></span> string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_type_extension"><a href="#val-string_of_type_extension" class="anchor"></a><code><span><span class="keyword">val</span> string_of_type_extension : <span><a href="Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given type extension.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_exception"><a href="#val-string_of_exception" class="anchor"></a><code><span><span class="keyword">val</span> string_of_exception : <span><a href="Exception/index.html#type-t_exception">Exception.t_exception</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given exception.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_value"><a href="#val-string_of_value" class="anchor"></a><code><span><span class="keyword">val</span> string_of_value : <span><a href="Value/index.html#type-t_value">Value.t_value</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given value.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_attribute"><a href="#val-string_of_attribute" class="anchor"></a><code><span><span class="keyword">val</span> string_of_attribute : <span><a href="Value/index.html#type-t_attribute">Value.t_attribute</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given attribute.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-string_of_method"><a href="#val-string_of_method" class="anchor"></a><code><span><span class="keyword">val</span> string_of_method : <span><a href="Value/index.html#type-t_method">Value.t_method</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>a string to describe the given method.</p></li></ul></div></div><h3 id="miscellaneous-functions"><a href="#miscellaneous-functions" class="anchor"></a>Miscellaneous functions</h3><div class="odoc-spec"><div class="spec value anchored" id="val-first_sentence_of_text"><a href="#val-first_sentence_of_text" class="anchor"></a><code><span><span class="keyword">val</span> first_sentence_of_text : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>Return the first sentence (until the first dot followed by a blank or the first blank line) of a text. Don't stop in the middle of <code>Code</code>, <code>CodePre</code>, <code>Verbatim</code>, <code>List</code>, <code>Enum</code>, <code>Latex</code>, <code>Link</code>, <code>Ref</code>, <code>Subscript</code> or <code>Superscript</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-first_sentence_and_rest_of_text"><a href="#val-first_sentence_and_rest_of_text" class="anchor"></a><code><span><span class="keyword">val</span> first_sentence_and_rest_of_text : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> <a href="#type-text">text</a> * <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>Return the first sentence (until the first dot followed by a blank or the first blank line) of a text, and the remaining text after. Don't stop in the middle of <code>Code</code>, <code>CodePre</code>, <code>Verbatim</code>, <code>List</code>, <code>Enum</code>, <code>Latex</code>, <code>Link</code>, <code>Ref</code>, <code>Subscript</code> or <code>Superscript</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-text_no_title_no_list"><a href="#val-text_no_title_no_list" class="anchor"></a><code><span><span class="keyword">val</span> text_no_title_no_list : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p>Return the given <code>text</code> without any title or list.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-text_concat"><a href="#val-text_concat" class="anchor"></a><code><span><span class="keyword">val</span> text_concat : <span><a href="../Odoc_types/index.html#type-text">Odoc_types.text</a> <span class="arrow">-></span></span> <span><span><a href="../Odoc_types/index.html#type-text">Odoc_types.text</a> list</span> <span class="arrow">-></span></span> <a href="../Odoc_types/index.html#type-text">Odoc_types.text</a></span></code></div><div class="spec-doc"><p><code>concat sep l</code> concats the given list of text <code>l</code>, each separated with the text <code>sep</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_titles_in_text"><a href="#val-get_titles_in_text" class="anchor"></a><code><span><span class="keyword">val</span> get_titles_in_text : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> <span><span>(int * <span>string option</span> * <a href="#type-text">text</a>)</span> list</span></span></code></div><div class="spec-doc"><p>Return the list of titles in a <code>text</code>. A title is a title level, an optional label and a text.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-create_index_lists"><a href="#val-create_index_lists" class="anchor"></a><code><span><span class="keyword">val</span> create_index_lists : <span><span><span class="type-var">'a</span> list</span> <span class="arrow">-></span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> string)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> list</span> list</span></span></code></div><div class="spec-doc"><p>Take a sorted list of elements, a function to get the name of an element and return the list of list of elements, where each list group elements beginning by the same letter. Since the original list is sorted, elements whose name does not begin with a letter should be in the first returned list.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_option"><a href="#val-remove_option" class="anchor"></a><code><span><span class="keyword">val</span> remove_option : <span><a href="../Types/index.html#type-type_expr">Types.type_expr</a> <span class="arrow">-></span></span> <a href="../Types/index.html#type-type_expr">Types.type_expr</a></span></code></div><div class="spec-doc"><p>Take a type and remove the option top constructor. This is useful when printing labels, we then remove the top option constructor for optional labels.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_optional"><a href="#val-is_optional" class="anchor"></a><code><span><span class="keyword">val</span> is_optional : <span><a href="../Asttypes/index.html#type-arg_label">Asttypes.arg_label</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Return <code>true</code> if the given label is optional.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-label_name"><a href="#val-label_name" class="anchor"></a><code><span><span class="keyword">val</span> label_name : <span><a href="../Asttypes/index.html#type-arg_label">Asttypes.arg_label</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Return the label name for the given label, i.e. removes the beginning '?' if present.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-use_hidden_modules"><a href="#val-use_hidden_modules" class="anchor"></a><code><span><span class="keyword">val</span> use_hidden_modules : <span><a href="Name/index.html#type-t">Name.t</a> <span class="arrow">-></span></span> <a href="Name/index.html#type-t">Name.t</a></span></code></div><div class="spec-doc"><p>Return the given name where the module name or part of it was removed, according to the list of modules which must be hidden (cf <code>Odoc_args</code>.hidden_modules)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-verbose"><a href="#val-verbose" class="anchor"></a><code><span><span class="keyword">val</span> verbose : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print the given string if the verbose mode is activated.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-warning"><a href="#val-warning" class="anchor"></a><code><span><span class="keyword">val</span> warning : <span>string <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Print a warning message to stderr. If warnings must be treated as errors, then the error counter is incremented.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_warnings"><a href="#val-print_warnings" class="anchor"></a><code><span><span class="keyword">val</span> print_warnings : <span>bool <a href="../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>A flag to indicate whether ocamldoc warnings must be printed or not.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-errors"><a href="#val-errors" class="anchor"></a><code><span><span class="keyword">val</span> errors : <span>int <a href="../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Increment this counter when an error is encountered. The ocamldoc tool will print the number of errors encountered exit with code 1 if this number is greater than 0.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-apply_opt"><a href="#val-apply_opt" class="anchor"></a><code><span><span class="keyword">val</span> apply_opt : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'b</span>)</span> <span class="arrow">-></span></span> <span><span><span class="type-var">'a</span> option</span> <span class="arrow">-></span></span> <span><span class="type-var">'b</span> option</span></span></code></div><div class="spec-doc"><p>Apply a function to an optional value.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-apply_if_equal"><a href="#val-apply_if_equal" class="anchor"></a><code><span><span class="keyword">val</span> apply_if_equal : <span><span>(<span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'a</span>)</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span><span class="type-var">'a</span> <span class="arrow">-></span></span> <span class="type-var">'a</span></span></code></div><div class="spec-doc"><p>Apply a function to a first value if it is not different from a second value. If the two values are different, return the second one.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-text_of_string"><a href="#val-text_of_string" class="anchor"></a><code><span><span class="keyword">val</span> text_of_string : <span>string <span class="arrow">-></span></span> <a href="#type-text">text</a></span></code></div><div class="spec-doc"><p><code>text_of_string s</code> returns the text structure from the given string.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Text_syntax</span> <p>if a syntax error is encountered.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-text_string_of_text"><a href="#val-text_string_of_text" class="anchor"></a><code><span><span class="keyword">val</span> text_string_of_text : <span><a href="#type-text">text</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>text_string_of_text text</code> returns the string representing the given <code>text</code>. This string can then be parsed again by <a href="#val-text_of_string"><code>Odoc_info.text_of_string</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_of_string"><a href="#val-info_of_string" class="anchor"></a><code><span><span class="keyword">val</span> info_of_string : <span>string <span class="arrow">-></span></span> <a href="#type-info">info</a></span></code></div><div class="spec-doc"><p><code>info_of_string s</code> parses the given string like a regular ocamldoc comment and return an <a href="#type-info"><code>Odoc_info.info</code></a> structure.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>an empty structure if there was a syntax error. TODO: change this</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_string_of_info"><a href="#val-info_string_of_info" class="anchor"></a><code><span><span class="keyword">val</span> info_string_of_info : <span><a href="#type-info">info</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>info_string_of_info info</code> returns the string representing the given <code>info</code>. This string can then be parsed again by <a href="#val-info_of_string"><code>Odoc_info.info_of_string</code></a>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-info_of_comment_file"><a href="#val-info_of_comment_file" class="anchor"></a><code><span><span class="keyword">val</span> info_of_comment_file : <span><span><a href="Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <a href="#type-info">info</a></span></code></div><div class="spec-doc"><p><code>info_of_comment_file file</code> parses the given file and return an <a href="#type-info"><code>Odoc_info.info</code></a> structure. The content of the file must have the same syntax as the content of a special comment. The given module list is used for cross reference.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Failure</span> <p>if the file could not be opened or there is a syntax error.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-remove_ending_newline"><a href="#val-remove_ending_newline" class="anchor"></a><code><span><span class="keyword">val</span> remove_ending_newline : <span>string <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>remove_ending_newline s</code> returns <code>s</code> without the optional ending newline.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Search"><a href="#module-Search" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Search/index.html">Search</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Research in elements</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Scan"><a href="#module-Scan" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Scan/index.html">Scan</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Scanning of collected information</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Dep"><a href="#module-Dep" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Dep/index.html">Dep</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div><div class="spec-doc"><p>Computation of dependencies.</p></div></div><h2 id="some-global-variables"><a href="#some-global-variables" class="anchor"></a>Some global variables</h2><div class="odoc-spec"><div class="spec module anchored" id="module-Global"><a href="#module-Global" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Global/index.html">Global</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-analyse_files"><a href="#val-analyse_files" class="anchor"></a><code><span><span class="keyword">val</span> analyse_files :
|
||
<span>?merge_options:<span><a href="../Odoc_types/index.html#type-merge_option">Odoc_types.merge_option</a> list</span> <span class="arrow">-></span></span>
|
||
<span>?include_dirs:<span>string list</span> <span class="arrow">-></span></span>
|
||
<span>?labels:bool <span class="arrow">-></span></span>
|
||
<span>?sort_modules:bool <span class="arrow">-></span></span>
|
||
<span>?no_stop:bool <span class="arrow">-></span></span>
|
||
<span>?init:<span><a href="../Odoc_module/index.html#type-t_module">Odoc_module.t_module</a> list</span> <span class="arrow">-></span></span>
|
||
<span><span><a href="../Odoc_global/index.html#type-source_file">Odoc_global.source_file</a> list</span> <span class="arrow">-></span></span>
|
||
<span><a href="Module/index.html#type-t_module">Module.t_module</a> list</span></span></code></div><div class="spec-doc"><p>Analysis of the given source files.</p><ul class="at-tags"><li class="parameter"><span class="at-tag">parameter</span> <span class="value">init</span> <p>is the list of modules already known from a previous analysis.</p></li></ul><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>the list of analysed top modules.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-dump_modules"><a href="#val-dump_modules" class="anchor"></a><code><span><span class="keyword">val</span> dump_modules : <span>string <span class="arrow">-></span></span> <span><span><a href="../Odoc_module/index.html#type-t_module">Odoc_module.t_module</a> list</span> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Dump of a list of modules into a file.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Failure</span> <p>if an error occurs.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-load_modules"><a href="#val-load_modules" class="anchor"></a><code><span><span class="keyword">val</span> load_modules : <span>string <span class="arrow">-></span></span> <span><a href="../Odoc_module/index.html#type-t_module">Odoc_module.t_module</a> list</span></span></code></div><div class="spec-doc"><p>Load of a list of modules from a file.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Failure</span> <p>if an error occurs.</p></li></ul></div></div></div></body></html> |