moonpool/dev/ocaml/Odoc_info/Name/index.html
2023-08-28 17:11:38 +00:00

2 lines
No EOL
3.6 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Name (ocaml.Odoc_info.Name)</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> &#x00BB; <a href="../index.html">Odoc_info</a> &#x00BB; Name</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Name</span></code></h1><p>Representation of element names.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span><span> = string</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-simple"><a href="#val-simple" class="anchor"></a><code><span><span class="keyword">val</span> simple : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Access to the simple name.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-concat"><a href="#val-concat" class="anchor"></a><code><span><span class="keyword">val</span> concat : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>concat t1 t2</code> returns the concatenation of <code>t1</code> and <code>t2</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-depth"><a href="#val-depth" class="anchor"></a><code><span><span class="keyword">val</span> depth : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> int</span></code></div><div class="spec-doc"><p>Return the depth of the name, i.e. the number of levels to the root. Example : <code>depth &quot;Toto.Tutu.name&quot;</code> = <code>3</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_relative"><a href="#val-get_relative" class="anchor"></a><code><span><span class="keyword">val</span> get_relative : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Take two names n1 and n2 = n3.n4 and return n4 if n3=n1 or else n2.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-get_relative_opt"><a href="#val-get_relative_opt" class="anchor"></a><code><span><span class="keyword">val</span> get_relative_opt : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Take two names n1 and n2 = n3.n4 and return n4 if n3=n1 and n1&lt;&gt;&quot;&quot; or else n2.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-father"><a href="#val-father" class="anchor"></a><code><span><span class="keyword">val</span> father : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Return the name of the 'father' (like <code>dirname</code> for a file name).</p></div></div></div></body></html>