mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 08:06:43 -05:00
9 lines
No EOL
9.9 KiB
HTML
9 lines
No EOL
9.9 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>WithMenhir (ocaml.Docstrings.WithMenhir)</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">Docstrings</a> » WithMenhir</nav><header class="odoc-preamble"><h1>Module <code><span>Docstrings.WithMenhir</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#extra-text">Extra text</a></li></ul></nav><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_docs"><a href="#val-symbol_docs" class="anchor"></a><code><span><span class="keyword">val</span> symbol_docs : <span><span>(<a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> * <a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a>)</span> <span class="arrow">-></span></span> <a href="../index.html#type-docs">docs</a></span></code></div><div class="spec-doc"><p>Fetch the item documentation for the current symbol. This also marks this documentation (for ambiguity warnings).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_docs_lazy"><a href="#val-symbol_docs_lazy" class="anchor"></a><code><span><span class="keyword">val</span> symbol_docs_lazy :
|
||
<span><span>(<a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> * <a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a>)</span> <span class="arrow">-></span></span>
|
||
<span><a href="../index.html#type-docs">docs</a> <a href="../../Stdlib/Lazy/index.html#type-t">Stdlib.Lazy.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_docs"><a href="#val-rhs_docs" class="anchor"></a><code><span><span class="keyword">val</span> rhs_docs : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-docs">docs</a></span></code></div><div class="spec-doc"><p>Fetch the item documentation for the symbols between two positions. This also marks this documentation (for ambiguity warnings).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_docs_lazy"><a href="#val-rhs_docs_lazy" class="anchor"></a><code><span><span class="keyword">val</span> rhs_docs_lazy :
|
||
<span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span>
|
||
<span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span>
|
||
<span><a href="../index.html#type-docs">docs</a> <a href="../../Stdlib/Lazy/index.html#type-t">Stdlib.Lazy.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mark_symbol_docs"><a href="#val-mark_symbol_docs" class="anchor"></a><code><span><span class="keyword">val</span> mark_symbol_docs :
|
||
<span><span>(<a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> * <a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a>)</span> <span class="arrow">-></span></span>
|
||
unit</span></code></div><div class="spec-doc"><p>Mark the item documentation for the current symbol (for ambiguity warnings).</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-mark_rhs_docs"><a href="#val-mark_rhs_docs" class="anchor"></a><code><span><span class="keyword">val</span> mark_rhs_docs : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> unit</span></code></div><div class="spec-doc"><p>Mark as associated the item documentation for the symbols between two positions (for ambiguity warnings)</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_info"><a href="#val-symbol_info" class="anchor"></a><code><span><span class="keyword">val</span> symbol_info : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-info">info</a></span></code></div><div class="spec-doc"><p>Fetch the field info for the current symbol.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_info"><a href="#val-rhs_info" class="anchor"></a><code><span><span class="keyword">val</span> rhs_info : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-info">info</a></span></code></div><div class="spec-doc"><p>Fetch the field info following the symbol at a given position.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_text"><a href="#val-symbol_text" class="anchor"></a><code><span><span class="keyword">val</span> symbol_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch the text preceding the current symbol.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_text_lazy"><a href="#val-symbol_text_lazy" class="anchor"></a><code><span><span class="keyword">val</span> symbol_text_lazy : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-text">text</a> <a href="../../Stdlib/Lazy/index.html#type-t">Stdlib.Lazy.t</a></span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_text"><a href="#val-rhs_text" class="anchor"></a><code><span><span class="keyword">val</span> rhs_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch the text preceding the symbol at the given position.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_text_lazy"><a href="#val-rhs_text_lazy" class="anchor"></a><code><span><span class="keyword">val</span> rhs_text_lazy : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <span><a href="../index.html#type-text">text</a> <a href="../../Stdlib/Lazy/index.html#type-t">Stdlib.Lazy.t</a></span></span></code></div></div><h4 id="extra-text"><a href="#extra-text" class="anchor"></a>Extra text</h4><p>There may be additional text attached to the delimiters of a block (e.g. <code>struct</code> and <code>end</code>). This is fetched by the following functions, which are applied to the contents of the block rather than the delimiters.</p><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_pre_extra_text"><a href="#val-symbol_pre_extra_text" class="anchor"></a><code><span><span class="keyword">val</span> symbol_pre_extra_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch additional text preceding the current symbol</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-symbol_post_extra_text"><a href="#val-symbol_post_extra_text" class="anchor"></a><code><span><span class="keyword">val</span> symbol_post_extra_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch additional text following the current symbol</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_pre_extra_text"><a href="#val-rhs_pre_extra_text" class="anchor"></a><code><span><span class="keyword">val</span> rhs_pre_extra_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch additional text preceding the symbol at the given position</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_post_extra_text"><a href="#val-rhs_post_extra_text" class="anchor"></a><code><span><span class="keyword">val</span> rhs_post_extra_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch additional text following the symbol at the given position</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-rhs_post_text"><a href="#val-rhs_post_text" class="anchor"></a><code><span><span class="keyword">val</span> rhs_post_text : <span><a href="../../Stdlib/Lexing/index.html#type-position">Stdlib.Lexing.position</a> <span class="arrow">-></span></span> <a href="../index.html#type-text">text</a></span></code></div><div class="spec-doc"><p>Fetch text following the symbol at the given position</p></div></div></div></body></html> |