mirror of
https://github.com/c-cube/moonpool.git
synced 2025-12-17 16:16:48 -05:00
2 lines
No EOL
7.5 KiB
HTML
2 lines
No EOL
7.5 KiB
HTML
<!DOCTYPE html>
|
||
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Value (ocaml.Odoc_info.Value)</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> » Value</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Value</span></code></h1><p>Representation and manipulation of values, class attributes and class methods.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t_value"><a href="#type-t_value" class="anchor"></a><code><span><span class="keyword">type</span> t_value</span><span> = <a href="../../Odoc_value/index.html#type-t_value">Odoc_value.t_value</a></span><span> = </span><span>{</span></code><ol><li id="type-t_value.val_name" class="def record field anchored"><a href="#type-t_value.val_name" class="anchor"></a><code><span>val_name : <a href="../Name/index.html#type-t">Name.t</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Complete name of the value.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_info" class="def record field anchored"><a href="#type-t_value.val_info" class="anchor"></a><code><span><span class="keyword">mutable</span> val_info : <span><a href="../index.html#type-info">info</a> option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Information found in the optional associated comment.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_type" class="def record field anchored"><a href="#type-t_value.val_type" class="anchor"></a><code><span>val_type : <a href="../../Types/index.html#type-type_expr">Types.type_expr</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>Type of the value.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_recursive" class="def record field anchored"><a href="#type-t_value.val_recursive" class="anchor"></a><code><span>val_recursive : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the value is recursive.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_parameters" class="def record field anchored"><a href="#type-t_value.val_parameters" class="anchor"></a><code><span><span class="keyword">mutable</span> val_parameters : <span><a href="../../Odoc_parameter/index.html#type-parameter">Odoc_parameter.parameter</a> list</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The parameters, if any.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_code" class="def record field anchored"><a href="#type-t_value.val_code" class="anchor"></a><code><span><span class="keyword">mutable</span> val_code : <span>string option</span>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>The code of the value, if we had the only the implementation file.</p><span class="comment-delim">*)</span></div></li><li id="type-t_value.val_loc" class="def record field anchored"><a href="#type-t_value.val_loc" class="anchor"></a><code><span><span class="keyword">mutable</span> val_loc : <a href="../index.html#type-location">location</a>;</span></code></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a value.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_attribute"><a href="#type-t_attribute" class="anchor"></a><code><span><span class="keyword">type</span> t_attribute</span><span> = <a href="../../Odoc_value/index.html#type-t_attribute">Odoc_value.t_attribute</a></span><span> = </span><span>{</span></code><ol><li id="type-t_attribute.att_value" class="def record field anchored"><a href="#type-t_attribute.att_value" class="anchor"></a><code><span>att_value : <a href="#type-t_value">t_value</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>an attribute has almost all the same information as a value</p><span class="comment-delim">*)</span></div></li><li id="type-t_attribute.att_mutable" class="def record field anchored"><a href="#type-t_attribute.att_mutable" class="anchor"></a><code><span>att_mutable : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the attribute is mutable.</p><span class="comment-delim">*)</span></div></li><li id="type-t_attribute.att_virtual" class="def record field anchored"><a href="#type-t_attribute.att_virtual" class="anchor"></a><code><span>att_virtual : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the attribute is virtual.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a class attribute.</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t_method"><a href="#type-t_method" class="anchor"></a><code><span><span class="keyword">type</span> t_method</span><span> = <a href="../../Odoc_value/index.html#type-t_method">Odoc_value.t_method</a></span><span> = </span><span>{</span></code><ol><li id="type-t_method.met_value" class="def record field anchored"><a href="#type-t_method.met_value" class="anchor"></a><code><span>met_value : <a href="#type-t_value">t_value</a>;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p>a method has almost all the same information as a value</p><span class="comment-delim">*)</span></div></li><li id="type-t_method.met_private" class="def record field anchored"><a href="#type-t_method.met_private" class="anchor"></a><code><span>met_private : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the method is private.</p><span class="comment-delim">*)</span></div></li><li id="type-t_method.met_virtual" class="def record field anchored"><a href="#type-t_method.met_virtual" class="anchor"></a><code><span>met_virtual : bool;</span></code><div class="def-doc"><span class="comment-delim">(*</span><p><code>true</code> if the method is virtual.</p><span class="comment-delim">*)</span></div></li></ol><code><span>}</span></code></div><div class="spec-doc"><p>Representation of a class method.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-is_function"><a href="#val-is_function" class="anchor"></a><code><span><span class="keyword">val</span> is_function : <span><a href="#type-t_value">t_value</a> <span class="arrow">-></span></span> bool</span></code></div><div class="spec-doc"><p>Return <code>true</code> if the value is a function, i.e. it has a functional type.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-value_parameter_text_by_name"><a href="#val-value_parameter_text_by_name" class="anchor"></a><code><span><span class="keyword">val</span> value_parameter_text_by_name : <span><a href="#type-t_value">t_value</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 associated to the given parameter name.</p></div></div></div></body></html> |