Skip to content

Commit

Permalink
Update yojson doc to 2.2.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
@Leonidas-from-XIV
Leonidas-from-XIV committed May 31, 2024
1 parent bb289cd commit 53fac6d
Show file tree
Hide file tree
Showing 21 changed files with 363 additions and 4 deletions.
4 changes: 2 additions & 2 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
<div class="by-name">
<h2>OCaml package documentation</h2>
<ol>
<li><a href="yojson/index.html">yojson</a> <span class="version">2.1.2</span></li>
<li><a href="yojson-bench/index.html">yojson-bench</a> <span class="version">2.1.2</span></li>
<li><a href="yojson/index.html">yojson</a> <span class="version">2.2.0</span></li>
<li><a href="yojson-five/index.html">yojson-five</a> <span class="version">2.2.0</span></li>
</ol>
</div>
</main>
Expand Down
2 changes: 0 additions & 2 deletions yojson-bench/index.html
View file

This file was deleted.

Empty file added yojson-five/Yojson_five/.dummy
View file
Empty file.
19 changes: 19 additions & 0 deletions yojson-five/Yojson_five/Ast/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Ast (yojson-five.Yojson_five.Ast)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../index.html">Yojson_five</a> &#x00BB; Ast</nav><header class="odoc-preamble"><h1>Module <code><span>Yojson_five.Ast</span></code></h1></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> = </span></code><ol><li id="type-t.Assoc" class="def variant constructor anchored"><a href="#type-t.Assoc" class="anchor"></a><code><span>| </span><span><span class="constructor">Assoc</span> <span class="keyword">of</span> <span><span>(string * <a href="#type-t">t</a>)</span> list</span></span></code></li><li id="type-t.List" class="def variant constructor anchored"><a href="#type-t.List" class="anchor"></a><code><span>| </span><span><span class="constructor">List</span> <span class="keyword">of</span> <span><a href="#type-t">t</a> list</span></span></code></li><li id="type-t.StringLit" class="def variant constructor anchored"><a href="#type-t.StringLit" class="anchor"></a><code><span>| </span><span><span class="constructor">StringLit</span> <span class="keyword">of</span> string</span></code></li><li id="type-t.IntLit" class="def variant constructor anchored"><a href="#type-t.IntLit" class="anchor"></a><code><span>| </span><span><span class="constructor">IntLit</span> <span class="keyword">of</span> string</span></code></li><li id="type-t.FloatLit" class="def variant constructor anchored"><a href="#type-t.FloatLit" class="anchor"></a><code><span>| </span><span><span class="constructor">FloatLit</span> <span class="keyword">of</span> string</span></code></li><li id="type-t.Bool" class="def variant constructor anchored"><a href="#type-t.Bool" class="anchor"></a><code><span>| </span><span><span class="constructor">Bool</span> <span class="keyword">of</span> bool</span></code></li><li id="type-t.Null" class="def variant constructor anchored"><a href="#type-t.Null" class="anchor"></a><code><span>| </span><span><span class="constructor">Null</span></span></code></li></ol></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_basic"><a href="#val-to_basic" class="anchor"></a><code><span><span class="keyword">val</span> to_basic :
<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>[&gt; <span>`Assoc of <span><span>(string * <span class="type-var">'a</span>)</span> list</span></span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span><span>| `Int</span> of int</span>
<span><span>| `List</span> of <span><span class="type-var">'a</span> list</span></span>
<span>| `Null</span>
<span><span>| `String</span> of string</span> ]</span> <span class="keyword">as</span> 'a</span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_safe"><a href="#val-to_safe" class="anchor"></a><code><span><span class="keyword">val</span> to_safe :
<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span>[&gt; <span>`Assoc of <span><span>(string * <span class="type-var">'a</span>)</span> list</span></span>
<span><span>| `Bool</span> of bool</span>
<span><span>| `Float</span> of float</span>
<span><span>| `Int</span> of int</span>
<span><span>| `Intlit</span> of string</span>
<span><span>| `List</span> of <span><span class="type-var">'a</span> list</span></span>
<span>| `Null</span>
<span><span>| `String</span> of string</span> ]</span> <span class="keyword">as</span> 'a</span></code></div></div></div></body></html>
94 changes: 94 additions & 0 deletions yojson-five/Yojson_five/Basic/index.html
View file

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions yojson-five/Yojson_five/Let_syntax/Result/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Result (yojson-five.Yojson_five.Let_syntax.Result)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../../index.html">Yojson_five</a> &#x00BB; <a href="../index.html">Let_syntax</a> &#x00BB; Result</nav><header class="odoc-preamble"><h1>Module <code><span>Let_syntax.Result</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-let*"><a href="#val-let*" class="anchor"></a><code><span><span class="keyword">val</span> let* :
<span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'c</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span class="type-var">'c</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-let+"><a href="#val-let+" class="anchor"></a><code><span><span class="keyword">val</span> let+ : <span><span><span>(<span class="type-var">'a</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span><span class="type-var">'a</span> <span class="arrow">&#45;&gt;</span></span> <span class="type-var">'c</span>)</span> <span class="arrow">&#45;&gt;</span></span> <span><span>(<span class="type-var">'c</span>, <span class="type-var">'b</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions yojson-five/Yojson_five/Let_syntax/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Let_syntax (yojson-five.Yojson_five.Let_syntax)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../index.html">Yojson_five</a> &#x00BB; Let_syntax</nav><header class="odoc-preamble"><h1>Module <code><span>Yojson_five.Let_syntax</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec module anchored" id="module-Result"><a href="#module-Result" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Result/index.html">Result</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div></div></body></html>
8 changes: 8 additions & 0 deletions yojson-five/Yojson_five/Lexer/index.html
View file

Large diffs are not rendered by default.

26 changes: 26 additions & 0 deletions yojson-five/Yojson_five/Parser/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Parser (yojson-five.Yojson_five.Parser)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../index.html">Yojson_five</a> &#x00BB; Parser</nav><header class="odoc-preamble"><h1>Module <code><span>Yojson_five.Parser</span></code></h1></header><div class="odoc-content"><div class="odoc-spec"><div class="spec value anchored" id="val-parse_list"><a href="#val-parse_list" class="anchor"></a><code><span><span class="keyword">val</span> parse_list :
<span><span><a href="../Ast/index.html#type-t">Ast.t</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="../Ast/index.html#type-t">Ast.t</a> list</span> * <span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_assoc"><a href="#val-parse_assoc" class="anchor"></a><code><span><span class="keyword">val</span> parse_assoc :
<span><span><span>(string * <a href="../Ast/index.html#type-t">Ast.t</a>)</span> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><span>(string * <a href="../Ast/index.html#type-t">Ast.t</a>)</span> list</span> * <span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse"><a href="#val-parse" class="anchor"></a><code><span><span class="keyword">val</span> parse :
<span><span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../Ast/index.html#type-t">Ast.t</a> * <span><a href="../Lexer/index.html#type-token">Lexer.token</a> list</span>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_from_lexbuf"><a href="#val-parse_from_lexbuf" class="anchor"></a><code><span><span class="keyword">val</span> parse_from_lexbuf :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Sedlexing</span>.lexbuf <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../Ast/index.html#type-t">Ast.t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_from_string"><a href="#val-parse_from_string" class="anchor"></a><code><span><span class="keyword">val</span> parse_from_string :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../Ast/index.html#type-t">Ast.t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_from_channel"><a href="#val-parse_from_channel" class="anchor"></a><code><span><span class="keyword">val</span> parse_from_channel :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Stdlib</span>.in_channel <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../Ast/index.html#type-t">Ast.t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-parse_from_file"><a href="#val-parse_from_file" class="anchor"></a><code><span><span class="keyword">val</span> parse_from_file :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="../Ast/index.html#type-t">Ast.t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html>
2 changes: 2 additions & 0 deletions yojson-five/Yojson_five/Read/Make/argument-1-F/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>F (yojson-five.Yojson_five.Read.Make.F)</title><link rel="stylesheet" href="../../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../../../index.html">Yojson_five</a> &#x00BB; <a href="../../index.html">Read</a> &#x00BB; <a href="../index.html">Make</a> &#x00BB; F</nav><header class="odoc-preamble"><h1>Parameter <code><span>Make.F</span></code></h1></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></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-convert"><a href="#val-convert" class="anchor"></a><code><span><span class="keyword">val</span> convert : <span><a href="../../../Ast/index.html#type-t">Ast.t</a> <span class="arrow">&#45;&gt;</span></span> <a href="#type-t">t</a></span></code></div></div></div></body></html>
14 changes: 14 additions & 0 deletions yojson-five/Yojson_five/Read/Make/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Make (yojson-five.Yojson_five.Read.Make)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 2.2.0"/><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">yojson-five</a> &#x00BB; <a href="../../index.html">Yojson_five</a> &#x00BB; <a href="../index.html">Read</a> &#x00BB; Make</nav><header class="odoc-preamble"><h1>Module <code><span>Read.Make</span></code></h1></header><nav class="odoc-toc"><ul><li><a href="#parameters">Parameters</a></li><li><a href="#signature">Signature</a></li></ul></nav><div class="odoc-content"><h2 id="parameters"><a href="#parameters" class="anchor"></a>Parameters</h2><div class="odoc-spec"><div class="spec parameter anchored" id="argument-1-F"><a href="#argument-1-F" class="anchor"></a><code><span><span class="keyword">module</span> </span><span><a href="argument-1-F/index.html">F</a></span><span> : <a href="../module-type-S/index.html">S</a></span></code></div></div><h2 id="signature"><a href="#signature" class="anchor"></a>Signature</h2><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> = <a href="argument-1-F/index.html#type-t">F.t</a></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-from_string"><a href="#val-from_string" class="anchor"></a><code><span><span class="keyword">val</span> from_string :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-from_channel"><a href="#val-from_channel" class="anchor"></a><code><span><span class="keyword">val</span> from_channel :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span><span class="xref-unresolved">Stdlib</span>.in_channel <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-from_file"><a href="#val-from_file" class="anchor"></a><code><span><span class="keyword">val</span> from_file :
<span>?fname:string <span class="arrow">&#45;&gt;</span></span>
<span>?lnum:int <span class="arrow">&#45;&gt;</span></span>
<span>string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div></div></div></body></html>
Loading

0 comments on commit 53fac6d

Please sign in to comment.