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

2 lines
No EOL
12 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>Search (ocaml.Odoc_info.Search)</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; Search</nav><header class="odoc-preamble"><h1>Module <code><span>Odoc_info.Search</span></code></h1><p>Research in elements</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec type anchored" id="type-result_element"><a href="#type-result_element" class="anchor"></a><code><span><span class="keyword">type</span> result_element</span><span> = <a href="../../Odoc_search/index.html#type-result_element">Odoc_search.result_element</a></span><span> = </span></code><ol><li id="type-result_element.Res_module" class="def variant constructor anchored"><a href="#type-result_element.Res_module" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_module</span> <span class="keyword">of</span> <a href="../Module/index.html#type-t_module">Module.t_module</a></span></code></li><li id="type-result_element.Res_module_type" class="def variant constructor anchored"><a href="#type-result_element.Res_module_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_module_type</span> <span class="keyword">of</span> <a href="../Module/index.html#type-t_module_type">Module.t_module_type</a></span></code></li><li id="type-result_element.Res_class" class="def variant constructor anchored"><a href="#type-result_element.Res_class" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_class</span> <span class="keyword">of</span> <a href="../Class/index.html#type-t_class">Class.t_class</a></span></code></li><li id="type-result_element.Res_class_type" class="def variant constructor anchored"><a href="#type-result_element.Res_class_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_class_type</span> <span class="keyword">of</span> <a href="../Class/index.html#type-t_class_type">Class.t_class_type</a></span></code></li><li id="type-result_element.Res_value" class="def variant constructor anchored"><a href="#type-result_element.Res_value" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_value</span> <span class="keyword">of</span> <a href="../Value/index.html#type-t_value">Value.t_value</a></span></code></li><li id="type-result_element.Res_type" class="def variant constructor anchored"><a href="#type-result_element.Res_type" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_type</span> <span class="keyword">of</span> <a href="../Type/index.html#type-t_type">Type.t_type</a></span></code></li><li id="type-result_element.Res_extension" class="def variant constructor anchored"><a href="#type-result_element.Res_extension" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_extension</span> <span class="keyword">of</span> <a href="../Extension/index.html#type-t_extension_constructor">Extension.t_extension_constructor</a></span></code></li><li id="type-result_element.Res_exception" class="def variant constructor anchored"><a href="#type-result_element.Res_exception" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_exception</span> <span class="keyword">of</span> <a href="../Exception/index.html#type-t_exception">Exception.t_exception</a></span></code></li><li id="type-result_element.Res_attribute" class="def variant constructor anchored"><a href="#type-result_element.Res_attribute" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_attribute</span> <span class="keyword">of</span> <a href="../Value/index.html#type-t_attribute">Value.t_attribute</a></span></code></li><li id="type-result_element.Res_method" class="def variant constructor anchored"><a href="#type-result_element.Res_method" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_method</span> <span class="keyword">of</span> <a href="../Value/index.html#type-t_method">Value.t_method</a></span></code></li><li id="type-result_element.Res_section" class="def variant constructor anchored"><a href="#type-result_element.Res_section" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_section</span> <span class="keyword">of</span> string * <a href="../index.html#type-text">text</a></span></code></li><li id="type-result_element.Res_recfield" class="def variant constructor anchored"><a href="#type-result_element.Res_recfield" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_recfield</span> <span class="keyword">of</span> <a href="../Type/index.html#type-t_type">Type.t_type</a> * <a href="../Type/index.html#type-record_field">Type.record_field</a></span></code></li><li id="type-result_element.Res_const" class="def variant constructor anchored"><a href="#type-result_element.Res_const" class="anchor"></a><code><span>| </span><span><span class="constructor">Res_const</span> <span class="keyword">of</span> <a href="../Type/index.html#type-t_type">Type.t_type</a> * <a href="../Type/index.html#type-variant_constructor">Type.variant_constructor</a></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-search_result"><a href="#type-search_result" class="anchor"></a><code><span><span class="keyword">type</span> search_result</span><span> = <span><a href="#type-result_element">result_element</a> list</span></span></code></div><div class="spec-doc"><p>The type representing a research result.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-search_by_name"><a href="#val-search_by_name" class="anchor"></a><code><span><span class="keyword">val</span> search_by_name : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../../Str/index.html#type-regexp">Str.regexp</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-search_result">search_result</a></span></code></div><div class="spec-doc"><p>Research of the elements whose name matches the given regular expression.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-values"><a href="#val-values" class="anchor"></a><code><span><span class="keyword">val</span> values : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Value/index.html#type-t_value">Value.t_value</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the values in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-extensions"><a href="#val-extensions" class="anchor"></a><code><span><span class="keyword">val</span> extensions : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Extension/index.html#type-t_extension_constructor">Extension.t_extension_constructor</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the extensions in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-exceptions"><a href="#val-exceptions" class="anchor"></a><code><span><span class="keyword">val</span> exceptions : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Exception/index.html#type-t_exception">Exception.t_exception</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the exceptions in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-types"><a href="#val-types" class="anchor"></a><code><span><span class="keyword">val</span> types : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Type/index.html#type-t_type">Type.t_type</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the types in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-attributes"><a href="#val-attributes" class="anchor"></a><code><span><span class="keyword">val</span> attributes : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Value/index.html#type-t_attribute">Value.t_attribute</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the class attributes in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-methods"><a href="#val-methods" class="anchor"></a><code><span><span class="keyword">val</span> methods : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Value/index.html#type-t_method">Value.t_method</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the class methods in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-classes"><a href="#val-classes" class="anchor"></a><code><span><span class="keyword">val</span> classes : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Class/index.html#type-t_class">Class.t_class</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the classes in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-class_types"><a href="#val-class_types" class="anchor"></a><code><span><span class="keyword">val</span> class_types : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Class/index.html#type-t_class_type">Class.t_class_type</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the class types in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-modules"><a href="#val-modules" class="anchor"></a><code><span><span class="keyword">val</span> modules : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the modules in a list of modules.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-module_types"><a href="#val-module_types" class="anchor"></a><code><span><span class="keyword">val</span> module_types : <span><span><a href="../Module/index.html#type-t_module">Module.t_module</a> list</span> <span class="arrow">&#45;&gt;</span></span> <span><a href="../Module/index.html#type-t_module_type">Module.t_module_type</a> list</span></span></code></div><div class="spec-doc"><p>A function to search all the module types in a list of modules.</p></div></div></div></body></html>