mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 08:06:43 -05:00
2 lines
No EOL
4.4 KiB
HTML
2 lines
No EOL
4.4 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Global (ocaml.Odoc_info.Global)</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> » <a href="../index.html">Odoc_info</a> » Global</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Global</span></code></h1></header><div class="odoc-content"><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><div class="odoc-spec"><div class="spec value anchored" id="val-warn_error"><a href="#val-warn_error" class="anchor"></a><code><span><span class="keyword">val</span> warn_error : <span>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-out_file"><a href="#val-out_file" class="anchor"></a><code><span><span class="keyword">val</span> out_file : <span>string <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The file used by the generators outputting only one file.</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>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>Verbose mode or not.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-target_dir"><a href="#val-target_dir" class="anchor"></a><code><span><span class="keyword">val</span> target_dir : <span>string <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The directory where files have to be generated.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-title"><a href="#val-title" class="anchor"></a><code><span><span class="keyword">val</span> title : <span><span>string option</span> <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The optional title to use in the generated documentation.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-intro_file"><a href="#val-intro_file" class="anchor"></a><code><span><span class="keyword">val</span> intro_file : <span><span>string option</span> <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The optional file whose content can be used as intro text.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_toc"><a href="#val-with_toc" class="anchor"></a><code><span><span class="keyword">val</span> with_toc : <span>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The flag which indicates if we must generate a table of contents.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_index"><a href="#val-with_index" class="anchor"></a><code><span><span class="keyword">val</span> with_index : <span>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The flag which indicates if we must generate an index.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_header"><a href="#val-with_header" class="anchor"></a><code><span><span class="keyword">val</span> with_header : <span>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The flag which indicates if we must generate a header.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_trailer"><a href="#val-with_trailer" class="anchor"></a><code><span><span class="keyword">val</span> with_trailer : <span>bool <a href="../../Stdlib/index.html#type-ref">ref</a></span></span></code></div><div class="spec-doc"><p>The flag which indicates if we must generate a trailer.</p></div></div></div></body></html> |