moonpool/dev/ocaml/Printtyp/Conflicts/index.html

5 lines
No EOL
4 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>Conflicts (ocaml.Printtyp.Conflicts)</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">Printtyp</a> &#x00BB; Conflicts</nav><header class="odoc-preamble"><h1>Module <code><span>Printtyp.Conflicts</span></code></h1><p>The <code>Conflicts</code> module keeps track of conflicts arising when attributing names to identifiers and provides functions that can print explanations for these conflict in error messages</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-exists"><a href="#val-exists" class="anchor"></a><code><span><span class="keyword">val</span> exists : <span>unit <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p><code>exists()</code> returns true if the current naming context renamed an identifier to avoid a name collision</p></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-explanation"><a href="#type-explanation" class="anchor"></a><code><span><span class="keyword">type</span> explanation</span><span> = </span><span>{</span></code><ol><li id="type-explanation.kind" class="def record field anchored"><a href="#type-explanation.kind" class="anchor"></a><code><span>kind : <a href="../index.html#type-namespace">namespace</a>;</span></code></li><li id="type-explanation.name" class="def record field anchored"><a href="#type-explanation.name" class="anchor"></a><code><span>name : string;</span></code></li><li id="type-explanation.root_name" class="def record field anchored"><a href="#type-explanation.root_name" class="anchor"></a><code><span>root_name : string;</span></code></li><li id="type-explanation.location" class="def record field anchored"><a href="#type-explanation.location" class="anchor"></a><code><span>location : <a href="../../Location/index.html#type-t">Location.t</a>;</span></code></li></ol><code><span>}</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-list_explanations"><a href="#val-list_explanations" class="anchor"></a><code><span><span class="keyword">val</span> list_explanations : <span>unit <span class="arrow">&#45;&gt;</span></span> <span><a href="#type-explanation">explanation</a> list</span></span></code></div><div class="spec-doc"><p><code>list_explanations()</code> return the list of conflict explanations collected up to this point, and reset the list of collected explanations</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_located_explanations"><a href="#val-print_located_explanations" class="anchor"></a><code><span><span class="keyword">val</span> print_located_explanations :
<span><a href="../../Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="#type-explanation">explanation</a> list</span> <span class="arrow">&#45;&gt;</span></span>
unit</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-print_explanations"><a href="#val-print_explanations" class="anchor"></a><code><span><span class="keyword">val</span> print_explanations : <span><a href="../../Stdlib/Format/index.html#type-formatter">Stdlib.Format.formatter</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Print all conflict explanations collected up to this point</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-reset"><a href="#val-reset" class="anchor"></a><code><span><span class="keyword">val</span> reset : <span>unit <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div></div></body></html>