mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 16:16:48 -05:00
2 lines
No EOL
6.2 KiB
HTML
2 lines
No EOL
6.2 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Parameter (ocaml.Odoc_info.Parameter)</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> » Parameter</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Parameter</span></code></h1><p>Representation and manipulation of method / function / class / module parameters.</p></header><nav class="odoc-toc"><ul><li><a href="#types">Types</a></li><li><a href="#functions">Functions</a></li></ul></nav><div class="odoc-content"><h2 id="types"><a href="#types" class="anchor"></a>Types</h2><div class="odoc-spec"><div class="spec type anchored" id="type-simple_name"><a href="#type-simple_name" class="anchor"></a><code><span><span class="keyword">type</span> simple_name</span><span> = <a href="../../Odoc_parameter/index.html#type-simple_name">Odoc_parameter.simple_name</a></span><span> = </span><span>{</span></code><ol><li id="type-simple_name.sn_name" class="def record field anchored"><a href="#type-simple_name.sn_name" class="anchor"></a><code><span>sn_name : string;</span></code></li><li id="type-simple_name.sn_type" class="def record field anchored"><a href="#type-simple_name.sn_type" class="anchor"></a><code><span>sn_type : <a href="../../Types/index.html#type-type_expr">Types.type_expr</a>;</span></code></li><li id="type-simple_name.sn_text" class="def record field anchored"><a href="#type-simple_name.sn_text" class="anchor"></a><code><span><span class="keyword">mutable</span> sn_text : <span><a href="../index.html#type-text">text</a> option</span>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a simple parameter name</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-param_info"><a href="#type-param_info" class="anchor"></a><code><span><span class="keyword">type</span> param_info</span><span> = <a href="../../Odoc_parameter/index.html#type-param_info">Odoc_parameter.param_info</a></span><span> = </span></code><ol><li id="type-param_info.Simple_name" class="def variant constructor anchored"><a href="#type-param_info.Simple_name" class="anchor"></a><code><span>| </span><span><span class="constructor">Simple_name</span> <span class="keyword">of</span> <a href="#type-simple_name">simple_name</a></span></code></li><li id="type-param_info.Tuple" class="def variant constructor anchored"><a href="#type-param_info.Tuple" class="anchor"></a><code><span>| </span><span><span class="constructor">Tuple</span> <span class="keyword">of</span> <span><a href="#type-param_info">param_info</a> list</span> * <a href="../../Types/index.html#type-type_expr">Types.type_expr</a></span></code></li></ol></div><div class="spec-doc"><p>Representation of parameter names. We need it to represent parameter names in tuples. The value <code>Tuple ([], t)</code> stands for an anonymous parameter.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-parameter"><a href="#type-parameter" class="anchor"></a><code><span><span class="keyword">type</span> parameter</span><span> = <a href="#type-param_info">param_info</a></span></code></div><div class="spec-doc"><p>A parameter is just a param_info.</p></div></div><h2 id="functions"><a href="#functions" class="anchor"></a>Functions</h2><div class="odoc-spec"><div class="spec value anchored" id="val-complete_name"><a href="#val-complete_name" class="anchor"></a><code><span><span class="keyword">val</span> complete_name : <span><a href="#type-parameter">parameter</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p>Access to the name as a string. For tuples, parentheses and commas are added.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-typ"><a href="#val-typ" class="anchor"></a><code><span><span class="keyword">val</span> typ : <span><a href="#type-parameter">parameter</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>Access to the complete type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-names"><a href="#val-names" class="anchor"></a><code><span><span class="keyword">val</span> names : <span><a href="#type-parameter">parameter</a> <span class="arrow">-></span></span> <span>string list</span></span></code></div><div class="spec-doc"><p>Access to the list of names ; only one for a simple parameter, or a list for a tuple.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-desc_by_name"><a href="#val-desc_by_name" class="anchor"></a><code><span><span class="keyword">val</span> desc_by_name : <span><a href="#type-parameter">parameter</a> <span class="arrow">-></span></span> <span>string <span class="arrow">-></span></span> <span><a href="../index.html#type-text">text</a> option</span></span></code></div><div class="spec-doc"><p>Access to the description of a specific name.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Not_found</span> <p>if no description is associated to the given name.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-type_by_name"><a href="#val-type_by_name" class="anchor"></a><code><span><span class="keyword">val</span> type_by_name : <span><a href="#type-parameter">parameter</a> <span class="arrow">-></span></span> <span>string <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>Access to the type of a specific name.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <span class="value">Not_found</span> <p>if no type is associated to the given name.</p></li></ul></div></div></div></body></html> |