Cleaning and added doc in the git repo

This commit is contained in:
Matthieu Dubuget
2020-08-26 03:44:00 +02:00
parent e4b72227c4
commit ba419d2de7
23 changed files with 859 additions and 16 deletions

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Group (ocaml-google-apps.GoogleApps.Contacts.Group)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../../index.html">GoogleApps</a> &#x00BB; <a href="../index.html">Contacts</a> &#x00BB; Group</nav><h1>Module <code>Contacts.Group</code></h1><p>A <span class="xref-unresolved" title="unresolved reference to &quot;Group.t&quot;"><a href="../index.html#module-Group"><code>Group</code></a>.t</span> is is a group of contacts.</p></header><dl><dt class="spec type" id="type-g"><a href="#type-g" class="anchor"></a><code><span class="keyword">type</span> g</code></dt></dl><dl><dt class="spec value" id="val-get_contact_group"><a href="#val-get_contact_group" class="anchor"></a><code><span class="keyword">val</span> get_contact_group : string <span>&#45;&gt;</span> <a href="index.html#type-g">g</a></code></dt><dt class="spec value" id="val-get_contacts"><a href="#val-get_contacts" class="anchor"></a><code><span class="keyword">val</span> get_contacts : <a href="index.html#type-g">g</a> <span>&#45;&gt;</span> <span><a href="../index.html#type-t">t</a> list</span></code></dt></dl></div></body></html>

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Contacts (ocaml-google-apps.GoogleApps.Contacts)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; Contacts</nav><h1>Module <code>GoogleApps.Contacts</code></h1><p>A <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span> contains the name, address, and various contact details of a contact.</p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec module" id="module-Group"><a href="#module-Group" class="anchor"></a><code><span class="keyword">module</span> <a href="Group/index.html">Group</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>A <span class="xref-unresolved" title="unresolved reference to &quot;Group.t&quot;"><a href="index.html#module-Group"><code>Group</code></a>.t</span> is is a group of contacts.</p></dd></dl><dl><dt class="spec value" id="val-get_contacts"><a href="#val-get_contacts" class="anchor"></a><code><span class="keyword">val</span> get_contacts : unit <span>&#45;&gt;</span> <span><a href="index.html#type-t">t</a> list</span></code></dt><dt class="spec value" id="val-create"><a href="#val-create" class="anchor"></a><code><span class="keyword">val</span> create : <span>given_name:string</span> <span>&#45;&gt;</span> <span>family_name:string</span> <span>&#45;&gt;</span> <span>email:string</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Create a contact</p></dd></dl><dl><dt class="spec value" id="val-get_emails"><a href="#val-get_emails" class="anchor"></a><code><span class="keyword">val</span> get_emails : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span><a href="../EmailField/index.html#type-t">EmailField.t</a> list</span></code></dt><dt class="spec value" id="val-get_family_name"><a href="#val-get_family_name" class="anchor"></a><code><span class="keyword">val</span> get_family_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-get_given_name"><a href="#val-get_given_name" class="anchor"></a><code><span class="keyword">val</span> get_given_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-get_full_name"><a href="#val-get_full_name" class="anchor"></a><code><span class="keyword">val</span> get_full_name : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt><dt class="spec value" id="val-get_phones"><a href="#val-get_phones" class="anchor"></a><code><span class="keyword">val</span> get_phones : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span><a href="../PhoneField/index.html#type-t">PhoneField.t</a> list</span></code></dt><dt class="spec value" id="val-get_contact_groups"><a href="#val-get_contact_groups" class="anchor"></a><code><span class="keyword">val</span> get_contact_groups : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span><a href="Group/index.html#type-g">Group.g</a> list</span></code></dt><dt class="spec value" id="val-add_phone"><a href="#val-add_phone" class="anchor"></a><code><span class="keyword">val</span> add_phone : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>field:<a href="../PhoneField/Field/index.html#type-t">PhoneField.Field.t</a></span> <span>&#45;&gt;</span> <span>number:string</span> <span>&#45;&gt;</span> <a href="../PhoneField/index.html#type-t">PhoneField.t</a></code></dt><dt class="spec value" id="val-add_to_group"><a href="#val-add_to_group" class="anchor"></a><code><span class="keyword">val</span> add_to_group : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>group:<a href="Group/index.html#type-g">Group.g</a></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dd><p>Adds a <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span> to a <span class="xref-unresolved" title="unresolved reference to &quot;Group.t&quot;"><a href="index.html#module-Group"><code>Group</code></a>.t</span></p></dd></dl></div></body></html>

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>EmailField (ocaml-google-apps.GoogleApps.EmailField)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; EmailField</nav><h1>Module <code>GoogleApps.EmailField</code></h1><p>An email field in a <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span>.</p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-get_address"><a href="#val-get_address" class="anchor"></a><code><span class="keyword">val</span> get_address : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt></dl></div></body></html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>HtmlOutput (ocaml-google-apps.GoogleApps.HtmlOutput)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; HtmlOutput</nav><h1>Module <code>GoogleApps.HtmlOutput</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-create_html_output_from_file"><a href="#val-create_html_output_from_file" class="anchor"></a><code><span class="keyword">val</span> create_html_output_from_file : string <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-set_sandbox_mode"><a href="#val-set_sandbox_mode" class="anchor"></a><code><span class="keyword">val</span> set_sandbox_mode : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>mode:<a href="../SandboxMode/index.html#type-t">SandboxMode.t</a></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-set_title"><a href="#val-set_title" class="anchor"></a><code><span class="keyword">val</span> set_title : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>title:string</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Menu (ocaml-google-apps.GoogleApps.Menu)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; Menu</nav><h1>Module <code>GoogleApps.Menu</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-add_to_ui"><a href="#val-add_to_ui" class="anchor"></a><code><span class="keyword">val</span> add_to_ui : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> unit</code></dt><dt class="spec value" id="val-add_separator"><a href="#val-add_separator" class="anchor"></a><code><span class="keyword">val</span> add_separator : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-add_item"><a href="#val-add_item" class="anchor"></a><code><span class="keyword">val</span> add_item : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>caption:string</span> <span>&#45;&gt;</span> <span>function_name:string</span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-add_sub_menu"><a href="#val-add_sub_menu" class="anchor"></a><code><span class="keyword">val</span> add_sub_menu : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> <span>submenu:<a href="index.html#type-t">t</a></span> <span>&#45;&gt;</span> <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Field (ocaml-google-apps.GoogleApps.PhoneField.Field)</title><link rel="stylesheet" href="../../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../../index.html">GoogleApps</a> &#x00BB; <a href="../index.html">PhoneField</a> &#x00BB; Field</nav><h1>Module <code>PhoneField.Field</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-work"><a href="#val-work" class="anchor"></a><code><span class="keyword">val</span> work : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-mobile"><a href="#val-mobile" class="anchor"></a><code><span class="keyword">val</span> mobile : <a href="index.html#type-t">t</a></code></dt><dt class="spec value" id="val-home"><a href="#val-home" class="anchor"></a><code><span class="keyword">val</span> home : <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>PhoneField (ocaml-google-apps.GoogleApps.PhoneField)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; PhoneField</nav><h1>Module <code>GoogleApps.PhoneField</code></h1><p>An email field in a <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span>.</p></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><div class="spec module" id="module-Field"><a href="#module-Field" class="anchor"></a><code><span class="keyword">module</span> <a href="Field/index.html">Field</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec value" id="val-get_phone_number"><a href="#val-get_phone_number" class="anchor"></a><code><span class="keyword">val</span> get_phone_number : <a href="index.html#type-t">t</a> <span>&#45;&gt;</span> string</code></dt></dl></div></body></html>

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>SandboxMode (ocaml-google-apps.GoogleApps.SandboxMode)</title><link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../../index.html">ocaml-google-apps</a> &#x00BB; <a href="../index.html">GoogleApps</a> &#x00BB; SandboxMode</nav><h1>Module <code>GoogleApps.SandboxMode</code></h1></header><dl><dt class="spec type" id="type-t"><a href="#type-t" class="anchor"></a><code><span class="keyword">type</span> t</code></dt></dl><dl><dt class="spec value" id="val-iframe"><a href="#val-iframe" class="anchor"></a><code><span class="keyword">val</span> iframe : <a href="index.html#type-t">t</a></code></dt></dl></div></body></html>

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>GoogleApps (ocaml-google-apps.GoogleApps)</title><link rel="stylesheet" href="../../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> <a href="../index.html">ocaml-google-apps</a> &#x00BB; GoogleApps</nav><h1>Module <code>GoogleApps</code></h1><p>OCaml binding for Google Apps (https://developers.google.com/apps-script/)</p></header><dl><dt class="spec value" id="val-log"><a href="#val-log" class="anchor"></a><code><span class="keyword">val</span> log : string <span>&#45;&gt;</span> unit</code></dt></dl><dl><dt class="spec module" id="module-Date"><a href="#module-Date" class="anchor"></a><code><span class="keyword">module</span> <a href="Date/index.html">Date</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>Standard JavaScript Date</p></dd></dl><dl><dt class="spec module" id="module-File"><a href="#module-File" class="anchor"></a><code><span class="keyword">module</span> <a href="File/index.html">File</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>Files in Google Drive.</p></dd></dl><dl><dt class="spec module" id="module-Range"><a href="#module-Range" class="anchor"></a><code><span class="keyword">module</span> <a href="Range/index.html">Range</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>spreadsheet ranges</p></dd></dl><div class="spec module" id="module-SandboxMode"><a href="#module-SandboxMode" class="anchor"></a><code><span class="keyword">module</span> <a href="SandboxMode/index.html">SandboxMode</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module" id="module-HtmlOutput"><a href="#module-HtmlOutput" class="anchor"></a><code><span class="keyword">module</span> <a href="HtmlOutput/index.html">HtmlOutput</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><div class="spec module" id="module-Menu"><a href="#module-Menu" class="anchor"></a><code><span class="keyword">module</span> <a href="Menu/index.html">Menu</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div><dl><dt class="spec module" id="module-Sheet"><a href="#module-Sheet" class="anchor"></a><code><span class="keyword">module</span> <a href="Sheet/index.html">Sheet</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>Access and modify spreadsheet sheets.</p></dd></dl><dl><dt class="spec module" id="module-EmailField"><a href="#module-EmailField" class="anchor"></a><code><span class="keyword">module</span> <a href="EmailField/index.html">EmailField</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>An email field in a <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span>.</p></dd></dl><dl><dt class="spec module" id="module-PhoneField"><a href="#module-PhoneField" class="anchor"></a><code><span class="keyword">module</span> <a href="PhoneField/index.html">PhoneField</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>An email field in a <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span>.</p></dd></dl><dl><dt class="spec module" id="module-Contacts"><a href="#module-Contacts" class="anchor"></a><code><span class="keyword">module</span> <a href="Contacts/index.html">Contacts</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></dt><dd><p>A <span class="xref-unresolved" title="unresolved reference to &quot;Contact.t&quot;"><code>Contact</code>.t</span> contains the name, address, and various contact details of a contact.</p></dd></dl><div class="spec module" id="module-GmailMessage"><a href="#module-GmailMessage" class="anchor"></a><code><span class="keyword">module</span> <a href="GmailMessage/index.html">GmailMessage</a> : <span class="keyword">sig</span> ... <span class="keyword">end</span></code></div></div></body></html>

View File

@ -0,0 +1,2 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>index (ocaml-google-apps.index)</title><link rel="stylesheet" href="../odoc.css"/><meta charset="utf-8"/><meta name="generator" content="odoc 1.5.1"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div class="content"><header><nav><a href="../index.html">Up</a> ocaml-google-apps</nav><h1 id="ocaml-google-apps-index"><a href="#ocaml-google-apps-index" class="anchor"></a>ocaml-google-apps index</h1><nav class="toc"><ul><li><a href="#library-ocaml-google-apps">Library ocaml-google-apps</a></li></ul></nav></header><h2 id="library-ocaml-google-apps"><a href="#library-ocaml-google-apps" class="anchor"></a>Library ocaml-google-apps</h2><p>The entry point of this library is the module: <a href="GoogleApps/index.html"><code>GoogleApps</code></a>.</p></div></body></html>