simon/moonpool
1
0
Fork 0
mirror of https://github.com/c-cube/moonpool.git synced 2025-12-18 08:36:43 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
moonpool/dev/ocaml/Odoc_info/Scan/class-scanner/index.html
c-cube ad1191e4f0 deploy: 9853fca2de
2023-08-28 17:11:38 +00:00

2 lines
No EOL
15 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>scanner (ocaml.Odoc_info.Scan.scanner)</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; <a href="../index.html">Scan</a> &#x00BB; scanner</nav><header class="odoc-preamble"><h1>Class <code><span>Scan.scanner</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec method anchored" id="method-scan_value"><a href="#method-scan_value" class="anchor"></a><code><span><span class="keyword">method</span> scan_value : <span><a href="../../Value/index.html#type-t_value">Value.t_value</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_pre"><a href="#method-scan_type_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_pre : <span><a href="../../Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_const"><a href="#method-scan_type_const" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_const : <span><a href="../../Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Type/index.html#type-variant_constructor">Type.variant_constructor</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_recfield"><a href="#method-scan_type_recfield" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_recfield : <span><a href="../../Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Type/index.html#type-record_field">Type.record_field</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type"><a href="#method-scan_type" class="anchor"></a><code><span><span class="keyword">method</span> scan_type : <span><a href="../../Type/index.html#type-t_type">Type.t_type</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_extension_constructor"><a href="#method-scan_extension_constructor" class="anchor"></a><code><span><span class="keyword">method</span> scan_extension_constructor : <span><a href="../../Extension/index.html#type-t_extension_constructor">Extension.t_extension_constructor</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_exception"><a href="#method-scan_exception" class="anchor"></a><code><span><span class="keyword">method</span> scan_exception : <span><a href="../../Exception/index.html#type-t_exception">Exception.t_exception</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_attribute"><a href="#method-scan_attribute" class="anchor"></a><code><span><span class="keyword">method</span> scan_attribute : <span><a href="../../Value/index.html#type-t_attribute">Value.t_attribute</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_method"><a href="#method-scan_method" class="anchor"></a><code><span><span class="keyword">method</span> scan_method : <span><a href="../../Value/index.html#type-t_method">Value.t_method</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_included_module"><a href="#method-scan_included_module" class="anchor"></a><code><span><span class="keyword">method</span> scan_included_module : <span><a href="../../Module/index.html#type-included_module">Module.included_module</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div></div><p>Scan of a type extension</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_extension_pre"><a href="#method-scan_type_extension_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_extension_pre : <span><a href="../../Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Override this method to perform controls on the extension's type, private and info. This method is called before scanning the extension's constructors.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>true if the extension's constructors must be scanned.</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_extension_constructors"><a href="#method-scan_type_extension_constructors" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_extension_constructors : <span><a href="../../Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>This method scans the constructors of the given type extension.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_type_extension"><a href="#method-scan_type_extension" class="anchor"></a><code><span><span class="keyword">method</span> scan_type_extension : <span><a href="../../Extension/index.html#type-t_type_extension">Extension.t_type_extension</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a type extension. Should not be overridden. It calls <code>scan_type_extension_pre</code> and if <code>scan_type_extension_pre</code> returns <code>true</code>, then it calls scan_type_extension_constructors.</p></div></div><p>Scan of a class.</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_comment"><a href="#method-scan_class_comment" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_comment : <span><a href="../../index.html#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a comment inside a class.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_pre"><a href="#method-scan_class_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_pre : <span><a href="../../Class/index.html#type-t_class">Class.t_class</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Override this method to perform controls on the class comment and params. This method is called before scanning the class elements.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>true if the class elements must be scanned.</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_elements"><a href="#method-scan_class_elements" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_elements : <span><a href="../../Class/index.html#type-t_class">Class.t_class</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>This method scans the elements of the given class.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class"><a href="#method-scan_class" class="anchor"></a><code><span><span class="keyword">method</span> scan_class : <span><a href="../../Class/index.html#type-t_class">Class.t_class</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a class. Should not be overridden. It calls <code>scan_class_pre</code> and if <code>scan_class_pre</code> returns <code>true</code>, then it calls scan_class_elements.</p></div></div><p>Scan of a class type.</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_type_comment"><a href="#method-scan_class_type_comment" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_type_comment : <span><a href="../../index.html#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a comment inside a class type.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_type_pre"><a href="#method-scan_class_type_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_type_pre : <span><a href="../../Class/index.html#type-t_class_type">Class.t_class_type</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Override this method to perform controls on the class type comment and form. This method is called before scanning the class type elements.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>true if the class type elements must be scanned.</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_type_elements"><a href="#method-scan_class_type_elements" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_type_elements : <span><a href="../../Class/index.html#type-t_class_type">Class.t_class_type</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>This method scans the elements of the given class type.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_class_type"><a href="#method-scan_class_type" class="anchor"></a><code><span><span class="keyword">method</span> scan_class_type : <span><a href="../../Class/index.html#type-t_class_type">Class.t_class_type</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a class type. Should not be overridden. It calls <code>scan_class_type_pre</code> and if <code>scan_class_type_pre</code> returns <code>true</code>, then it calls scan_class_type_elements.</p></div></div><p>Scan of modules.</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_comment"><a href="#method-scan_module_comment" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_comment : <span><a href="../../index.html#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a comment inside a module.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_pre"><a href="#method-scan_module_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_pre : <span><a href="../../Module/index.html#type-t_module">Module.t_module</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Override this method to perform controls on the module comment and form. This method is called before scanning the module elements.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>true if the module elements must be scanned.</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_elements"><a href="#method-scan_module_elements" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_elements : <span><a href="../../Module/index.html#type-t_module">Module.t_module</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>This method scans the elements of the given module.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module"><a href="#method-scan_module" class="anchor"></a><code><span><span class="keyword">method</span> scan_module : <span><a href="../../Module/index.html#type-t_module">Module.t_module</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a module. Should not be overridden. It calls <code>scan_module_pre</code> and if <code>scan_module_pre</code> returns <code>true</code>, then it calls scan_module_elements.</p></div></div><p>Scan of module types.</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_type_comment"><a href="#method-scan_module_type_comment" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_type_comment : <span><a href="../../index.html#type-text">text</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a comment inside a module type.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_type_pre"><a href="#method-scan_module_type_pre" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_type_pre : <span><a href="../../Module/index.html#type-t_module_type">Module.t_module_type</a> <span class="arrow">&#45;&gt;</span></span> bool</span></code></div><div class="spec-doc"><p>Override this method to perform controls on the module type comment and form. This method is called before scanning the module type elements.</p><ul class="at-tags"><li class="returns"><span class="at-tag">returns</span> <p>true if the module type elements must be scanned.</p></li></ul></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_type_elements"><a href="#method-scan_module_type_elements" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_type_elements : <span><a href="../../Module/index.html#type-t_module_type">Module.t_module_type</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>This method scans the elements of the given module type.</p></div></div><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_type"><a href="#method-scan_module_type" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_type : <span><a href="../../Module/index.html#type-t_module_type">Module.t_module_type</a> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan of a module type. Should not be overridden. It calls <code>scan_module_type_pre</code> and if <code>scan_module_type_pre</code> returns <code>true</code>, then it calls scan_module_type_elements.</p></div></div><p>Main scanning method.</p><div class="odoc-spec"><div class="spec method anchored" id="method-scan_module_list"><a href="#method-scan_module_list" class="anchor"></a><code><span><span class="keyword">method</span> scan_module_list : <span><span><a href="../../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> unit</span></code></div><div class="spec-doc"><p>Scan a list of modules.</p></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink