diff options
author | sternenseemann <git@lukasepple.de> | 2017-02-18 10:39:33 +0100 |
---|---|---|
committer | sternenseemann <git@lukasepple.de> | 2017-02-18 10:39:33 +0100 |
commit | 95cdf71383e4a4b67d4ba7cfaeb61f37edcaa28e (patch) | |
tree | 3bf99fa94e86d50c91b0a1e38359c0dc3ed1bafd | |
parent | 6c0781756a4f184d4fa189471536b701308a5ef0 (diff) |
Update logbook doc to 84a3c76.
-rw-r--r-- | doc/Log.html | 118 | ||||
-rw-r--r-- | doc/html.stamp | 1 | ||||
-rw-r--r-- | doc/index.html | 29 | ||||
-rw-r--r-- | doc/index_attributes.html | 19 | ||||
-rw-r--r-- | doc/index_class_types.html | 19 | ||||
-rw-r--r-- | doc/index_classes.html | 19 | ||||
-rw-r--r-- | doc/index_exceptions.html | 19 | ||||
-rw-r--r-- | doc/index_extensions.html | 19 | ||||
-rw-r--r-- | doc/index_methods.html | 19 | ||||
-rw-r--r-- | doc/index_module_types.html | 19 | ||||
-rw-r--r-- | doc/index_modules.html | 26 | ||||
-rw-r--r-- | doc/index_types.html | 42 | ||||
-rw-r--r-- | doc/index_values.html | 40 | ||||
-rw-r--r-- | doc/style.css | 252 | ||||
-rw-r--r-- | doc/type_Log.html | 22 |
15 files changed, 663 insertions, 0 deletions
diff --git a/doc/Log.html b/doc/Log.html new file mode 100644 index 0000000..58619ba --- /dev/null +++ b/doc/Log.html @@ -0,0 +1,118 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link rel="Up" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><link title="Log" rel="Section" href="#1_Log"> +<link title="Log Representation" rel="Subsection" href="#2_LogRepresentation"> +<link title="Log Parsing" rel="Subsection" href="#2_LogParsing"> +<link title="Log Building" rel="Subsection" href="#2_LogBuilding"> +<title>Log</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Module <a href="type_Log.html">Log</a></h1> + +<pre><span class="keyword">module</span> Log: <code class="code"><span class="keyword">sig</span></code> <a href="Log.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top"> +OCaml representation and parsing of the + <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>. +<p> + + <em>84a3c76 — <a href="https://github.com/sternenseemann/logbook ">homepage</a></em><br> +</div> +<hr width="100%"> +<br> +<h1 id="1_Log">Log</h1><br> +<br> +<h2 id="2_LogRepresentation">Log Representation</h2><br> + +<pre><code><span id="TYPEprivacy_level"><span class="keyword">type</span> <code class="type"></code>privacy_level</span> = </code></pre><table class="typetable"> +<tr> +<td align="left" valign="top" > +<code><span class="keyword">|</span></code></td> +<td align="left" valign="top" > +<code><span id="TYPEELTprivacy_level.Private"><span class="constructor">Private</span></span></code></td> + +</tr> +<tr> +<td align="left" valign="top" > +<code><span class="keyword">|</span></code></td> +<td align="left" valign="top" > +<code><span id="TYPEELTprivacy_level.Semi_private"><span class="constructor">Semi_private</span></span></code></td> + +</tr> +<tr> +<td align="left" valign="top" > +<code><span class="keyword">|</span></code></td> +<td align="left" valign="top" > +<code><span id="TYPEELTprivacy_level.Public"><span class="constructor">Public</span></span></code></td> + +</tr></table> + +<div class="info "> +Describes, how private a log item is. Semi-private means “visible to trusted persons”<br> +</div> + + +<pre><code><span id="TYPEitem"><span class="keyword">type</span> <code class="type"></code>item</span> = </code></pre><table class="typetable"> +<tr> +<td align="left" valign="top" > +<code><span class="keyword">|</span></code></td> +<td align="left" valign="top" > +<code><span id="TYPEELTitem.Item"><span class="constructor">Item</span></span> <span class="keyword">of</span> <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> * string * string</code></code></td> + +</tr></table> + +<div class="info "> +A log item consisting of a title, a text (formatting/markup unknown) and its privacy level.<br> +</div> + + +<pre><code><span id="TYPElog_entry"><span class="keyword">type</span> <code class="type"></code>log_entry</span> = </code></pre><table class="typetable"> +<tr> +<td align="left" valign="top" > +<code><span class="keyword">|</span></code></td> +<td align="left" valign="top" > +<code><span id="TYPEELTlog_entry.Log_entry"><span class="constructor">Log_entry</span></span> <span class="keyword">of</span> <code class="type">Ptime.date * string * <a href="Log.html#TYPEitem">item</a> list</code></code></td> + +</tr></table> + +<div class="info "> +A log entry consisting of a date (point in time is sufficient, so Ptime is used), a summary and items<br> +</div> + + +<pre><span id="TYPElog"><span class="keyword">type</span> <code class="type"></code>log</span> = <code class="type"><a href="Log.html#TYPElog_entry">log_entry</a> list</code> </pre> +<div class="info "> +A log file consisting of multiple log entries for multiple days<br> +</div> + + +<pre><span id="VALcompatible_privacy"><span class="keyword">val</span> compatible_privacy</span> : <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> -> <a href="Log.html#TYPEprivacy_level">privacy_level</a> -> bool</code></pre><div class="info "> +A test to check wether a privacy level of e. g. an item is + compatible with the (maximum) privacy level available.<br> +</div> + +<pre><span id="VALprivacy_level_of_char"><span class="keyword">val</span> privacy_level_of_char</span> : <code class="type">char -> <a href="Log.html#TYPEprivacy_level">privacy_level</a> option</code></pre><div class="info "> +Get the corresponding privacy level for a char<br> +</div> + +<pre><span id="VALfilter_privacy_level"><span class="keyword">val</span> filter_privacy_level</span> : <code class="type"><a href="Log.html#TYPEprivacy_level">privacy_level</a> -> <a href="Log.html#TYPEitem">item</a> list -> <a href="Log.html#TYPEitem">item</a> list</code></pre><br> +<h2 id="2_LogParsing">Log Parsing</h2> +<p> + + log files are parsed using <a href="https://github.com/inhabitedtype/angstrom">angstrom</a>.<br> + +<pre><span id="VALlog_parser"><span class="keyword">val</span> log_parser</span> : <code class="type"><a href="Log.html#TYPElog">log</a> Angstrom.t</code></pre><div class="info "> +An angstrom parser for log files<br> +</div> +<br> +<h2 id="2_LogBuilding">Log Building</h2><br> +</body></html> \ No newline at end of file diff --git a/doc/html.stamp b/doc/html.stamp new file mode 100644 index 0000000..b9087d0 --- /dev/null +++ b/doc/html.stamp @@ -0,0 +1 @@ +14b4fda0d39bbbc30f75a24e2252a457 \ No newline at end of file diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000..aaeca88 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,29 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title></title> +</head> +<body> +<h1></h1> +<ul class="indexlist"> +<li><a href="index_types.html">Index of types</a></li> +<li><a href="index_values.html">Index of values</a></li> +<li><a href="index_modules.html">Index of modules</a></li> +</ul> +<br/><br> +<table class="indextable"> +<tr><td class="module"><a href="Log.html">Log</a></td><td><div class="info"> +OCaml representation and parsing of the + <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>. +</div> +</td></tr> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_attributes.html b/doc/index_attributes.html new file mode 100644 index 0000000..2409fe6 --- /dev/null +++ b/doc/index_attributes.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of class attributes</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of class attributes</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_class_types.html b/doc/index_class_types.html new file mode 100644 index 0000000..418e036 --- /dev/null +++ b/doc/index_class_types.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of class types</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of class types</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_classes.html b/doc/index_classes.html new file mode 100644 index 0000000..a7bfbb0 --- /dev/null +++ b/doc/index_classes.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of classes</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of classes</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_exceptions.html b/doc/index_exceptions.html new file mode 100644 index 0000000..6e44d17 --- /dev/null +++ b/doc/index_exceptions.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of exceptions</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of exceptions</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_extensions.html b/doc/index_extensions.html new file mode 100644 index 0000000..04c62f4 --- /dev/null +++ b/doc/index_extensions.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of extensions</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of extensions</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_methods.html b/doc/index_methods.html new file mode 100644 index 0000000..3c62571 --- /dev/null +++ b/doc/index_methods.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of class methods</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of class methods</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_module_types.html b/doc/index_module_types.html new file mode 100644 index 0000000..010a71a --- /dev/null +++ b/doc/index_module_types.html @@ -0,0 +1,19 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of module types</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of module types</h1> +<table> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_modules.html b/doc/index_modules.html new file mode 100644 index 0000000..83fa5df --- /dev/null +++ b/doc/index_modules.html @@ -0,0 +1,26 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of modules</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of modules</h1> +<table> +<tr><td align="left"><br>L</td></tr> +<tr><td><a href="Log.html">Log</a> </td> +<td><div class="info"> +OCaml representation and parsing of the + <a href="https://gist.github.com/Profpatsch/092ff68fa267b9fa0ccbe13e98149b21">log format</a>. +</div> +</td></tr> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_types.html b/doc/index_types.html new file mode 100644 index 0000000..c91a6cc --- /dev/null +++ b/doc/index_types.html @@ -0,0 +1,42 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of types</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of types</h1> +<table> +<tr><td align="left"><br>I</td></tr> +<tr><td><a href="Log.html#TYPEitem">item</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +A log item consisting of a title, a text (formatting/markup unknown) and its privacy level. +</div> +</td></tr> +<tr><td align="left"><br>L</td></tr> +<tr><td><a href="Log.html#TYPElog">log</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +A log file consisting of multiple log entries for multiple days +</div> +</td></tr> +<tr><td><a href="Log.html#TYPElog_entry">log_entry</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +A log entry consisting of a date (point in time is sufficient, so Ptime is used), a summary and items +</div> +</td></tr> +<tr><td align="left"><br>P</td></tr> +<tr><td><a href="Log.html#TYPEprivacy_level">privacy_level</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +Describes, how private a log item is. +</div> +</td></tr> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/index_values.html b/doc/index_values.html new file mode 100644 index 0000000..17e7130 --- /dev/null +++ b/doc/index_values.html @@ -0,0 +1,40 @@ +<html> +<head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Index of values</title> +</head> +<body> +<div class="navbar"> <a class="up" href="index.html" title="Index">Up</a> + </div> +<h1>Index of values</h1> +<table> +<tr><td align="left"><br>C</td></tr> +<tr><td><a href="Log.html#VALcompatible_privacy">compatible_privacy</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +A test to check wether a privacy level of e. +</div> +</td></tr> +<tr><td align="left"><br>F</td></tr> +<tr><td><a href="Log.html#VALfilter_privacy_level">filter_privacy_level</a> [<a href="Log.html">Log</a>]</td> +<td></td></tr> +<tr><td align="left"><br>L</td></tr> +<tr><td><a href="Log.html#VALlog_parser">log_parser</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +An angstrom parser for log files +</div> +</td></tr> +<tr><td align="left"><br>P</td></tr> +<tr><td><a href="Log.html#VALprivacy_level_of_char">privacy_level_of_char</a> [<a href="Log.html">Log</a>]</td> +<td><div class="info"> +Get the corresponding privacy level for a char +</div> +</td></tr> +</table> +</body> +</html> \ No newline at end of file diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..cd01d86 --- /dev/null +++ b/doc/style.css @@ -0,0 +1,252 @@ +@charset "UTF-8"; +/* Copyright (c) 2016 Daniel C. Bünzli. All rights reserved. + Distributed under the ISC license, see terms at the end of the file. + odig v0.0.1-36-gabe18e1 */ + +/* Reset a few things. */ + +html,body,div,span,applet,object,iframe,h1,h2,h3,h4,h5,h6,p,blockquote,pre, +a,abbr,acronym,address,big,cite,code,del,dfn,em,img,ins,kbd,q,s,samp, +small,strike,strong,sub,sup,tt,var,b,u,i,center,dl,dt,dd,ol,ul,li, +fieldset,form,label,legend,table,caption,tbody,tfoot,thead,tr,th,td, +article,aside,canvas,details,embed,figure,figcaption,footer,header,hgroup, +menu,nav,output,ruby,section,summary,time,mark,audio,video +{ margin: 0; padding: 0; border: 0; outline: 0; font-size: 100%; + font: inherit; line-height: inherit; vertical-align: baseline; + text-align: inherit; color: inherit; background: transparent; } + +table { border-collapse: collapse; border-spacing: 0; } + +html { box-sizing: border-box } +*, *:before, *:after { box-sizing: inherit; } + +/* Basic page layout */ + +body +{ font-family: Helvetica, "DejaVu Sans", Arial, sans-serif; + font-weight: normal; + font-size: 0.875rem; + line-height: 1.25rem; + text-align: left; + min-width: 40ex; + max-width: 78ex; + padding: 1.25rem; + margin-left: 3.75rem; + color: #222; background: #FAFAFA; } + +b { font-weight: bold } +em { font-style: italic } + +.superscript { vertical-align: super; } +.subscript { vertical-align: sub; } +.superscript, .subscript +{ font-size : 0.75rem; line-height: 0; margin-left: 0.2ex; } + +/* ocamldoc markup workaround hacks. + See http://caml.inria.fr/mantis/view.php?id=7351 */ + +hr +{ display: none } /* Would be nice to have but we cannot get that to + interact well with our h1's because of br markup noise */ + +br { display: none } /* Annoying, hide them. */ +code br { display: block } /* Except in signatures. */ + +.codepre br + br { display: none } +h1 + pre { margin-bottom: 0.625rem } /* Toplevel module description */ + +/* Links and anchors */ + +a { text-decoration:none; color:#2C5CBD; } +a:hover { box-shadow:0 1px 0 0 #2C5CBD; } +*:target { /* Anchor highlight */ background-color: #FFF8E5; + box-shadow: 0 0 0 2px #FFF8E5, 0 0 0 3px #DDDDDD; } + +a { text-decoration:none; color:#2C5CBD; } +a:hover { box-shadow:0 1px 0 0 #2C5CBD; } +*:target /* Linked highlight */ +{ background-color: #FFF8E5; + box-shadow: 0 0 0 2px #FFF8E5, 0 0 0 3px #DDD; } + +.anchored:hover a.anchor { visibility: visible; } + +a.anchor:before { content: "#" } +a.anchor:hover { box-shadow: none; text-decoration: underline } +a.anchor +{ visibility: hidden; position: absolute; /* top: 0px; */ + margin-left: -3ex; + font-weight: normal; + font-style: normal; + padding-right: 1ex; padding-left: 1ex; /* To remain selectable */ + color: #AAA; } + +/* Sections and document divisions + + Many of the modules of the stdlib start at h6, we make it look like + h1 and the .7 div (sic) like h2. */ + +h1, h2, h3, h6, .h7 +{ font-weight: bold; padding-top: 0.625rem; margin-top: 1.25rem } + +h1, h6 +{ font-size: 1.25rem; + line-height: 2.4375rem; /* 2.5 rem - border width */ + border-top-style: solid; + border-width: 1px; + border-color: #DDDDDD; } + +h3 { margin-top: 0.625rem; } + +br + * { margin-top: 0.625rem; } /* Ideally this would be h1 + * */ + +h2, .h7 { font-size: 1.125rem; } +h1 + h2, h6 + .h7 { margin-top: 0.625rem; padding-top: 0rem; } + +/* Paragraphs, lists and tables */ + +p { margin-top: 1.25rem } +e.info p, li p { margin-top: 0.625rem } + +table { margin-top: 0.625rem } +.info.module.top { margin-left: 0em } /* Toplevel module description */ +.info { margin-left: 1ex; margin-top: 0.15625rem } + +td .info { margin:0; padding:0; margin-left: 2em;} /* Description in indexes */ + +ul, ol { margin-top: 0.625rem; margin-bottom: 0.625rem; + list-style-position: outside } +ul + p, ol + p { margin-top: 0em } +ul { list-style-type: square } + +ul > li { margin-left: 1.375rem; } +ol > li { margin-left: 1.7rem; } + +/* Preformatted and code */ + +tt, code, pre +{ font-family: Menlo, "DejaVu Sans Mono", "Bitstream Vera Sans Mono", + monospace; + font-weight: normal; + font-size: 0.75rem; } + +h1 tt, h1 code, h6 tt, h6 code { font-size: 1.125rem } +h2 tt, h2 code, .h7 tt, .h7 code { font-size: 1rem } + +pre { margin-top: 1.25rem; } + +pre.verbatim, pre.codepre +{ padding-left: 0.25rem; + padding-right: 0.25rem; + margin-left: -0.25rem; + margin-right: -0.25rem; + padding-bottom: 0.3125rem; + padding-top: 0.3125rem; + margin-bottom: 0.265rem; /* Sometimes there's text without <p> + http://caml.inria.fr/mantis/view.php?id=7353 */ + line-height: 1.1875rem; + background: #F1F1F1; } + +pre .code { background: inherit; } +.code { + /* If we can avoid it. */ + /* background: #F1F1F1; + padding-top:1px; padding-bottom:1px; + padding-left:1px; padding-right:1px; + border-radius:2px; */ } + +.keyword { font-weight: bold } +.comment { color: #888; font-style:italic } +.constructor { color: #208000; } +.string { color: brown; } +.warning { color: crimson; } + +.typetable { margin-top: 0em } + +.paramstable code { margin-left: 1ex; margin-right: 1ex; } +.sig_block { margin-left: 1em } + +/* Images */ + +img { margin-top: 1.25rem } + +/* Index tables */ + +ul.indexlist { list-style-type: none; margin-left:0; padding:0; } +ul.indexlist li { margin-left:0; padding: 0; } + +/* Odig package index */ + +.by-name ol, .by-tag ol, .errors ol { list-style-type: none; margin-left:0; } +.by-name ol ol, .by-tag ol ol { margin-top:0; margin-bottom: 0 } +.by-name li, .by-tag li, .errors li { margin-left:0; } + +.by-name .version { font-size: 0.625rem; color: #AAA } +.by-name nav { margin-bottom: 0.625rem } +.by-name nav a +{ text-transform: uppercase; font-size: 1.125rem; + margin-right:1ex; color: #222; display: inline-block; } + +.by-tag nav a { margin-right:1ex; color: #222; display: inline-block; } +.by-tag > ol > li { margin-top: 0.625rem; } +.by-tag > ol > li > span, +.by-tag > ol > li > ol, +.by-tag > ol > li > ol > li { display: inline-block; margin-right: 1ex; } + +/* Odig package page */ + +.package nav { display: inline; font-size: 0.875rem; font-weight: normal; } +.package .version { font-size: 0.875rem; } + +/* This doesn't work in 4.03 because of spurious br's */ +h1 + .indextable, h1 + .sel { margin-top: 0.625rem } +.sel { font-weight: normal; font-style: italic; + font-size:0.875rem; margin-top:1.25rem; } +.sel + .indextable { margin-top:0.625rem; + margin-bottom: 1.25rem; margin-left: 1ex; } + +.package.info { margin: 0;} +.package.info td:first-child { font-style: italic; padding-right: 2ex; } +.package.info ul { list-style-type: none; display: inline; margin:0; } +.package.info li { display: inline-block; margin:0; margin-right:1ex; } +#info-authors li, #info-maintainers li { display:block; } + +/* Odig ocamldoc adjustements. */ + +#info, .by-name h2, .by-tag h2, .errors h2 +{ font-size: 1.25rem; + line-height: 2.4375rem; /* 2.5 rem - border width */ + border-top-style: solid; + border-width: 1px; + border-color: #DDDDDD; } + +#info + *, .by-name h2 + *, .by-tag h2 + *, .errors h2 { margin-top: 0.625rem; } + +body h1:first-child { display: none } /* package page. */ + +/* Mobile adjustements + Can't really do anything we need to get a <meta> for viewport generated */ + +@media only screen and (max-width: 78ex) +{ body { margin: auto; } } + +/* Print adjustements. */ + +@media print +{ body { color: black; background: white; } + body nav:first-child { visibility: hidden; }} + +/*--------------------------------------------------------------------------- + Copyright (c) 2016 Daniel C. Bünzli + + Permission to use, copy, modify, and/or distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + ---------------------------------------------------------------------------*/ diff --git a/doc/type_Log.html b/doc/type_Log.html new file mode 100644 index 0000000..cfa97de --- /dev/null +++ b/doc/type_Log.html @@ -0,0 +1,22 @@ +<html><head> +<link rel="stylesheet" href="style.css" type="text/css"> +<meta content="text/html; charset=utf-8" http-equiv="Content-Type"> +<meta name="viewport" content="width=device-width, initial-scale=1"> +<link rel="Start" href="index.html"> +<link title="Index of types" rel=Appendix href="index_types.html"> +<link title="Index of values" rel=Appendix href="index_values.html"> +<link title="Index of modules" rel=Appendix href="index_modules.html"> +<link title="Log" rel="Chapter" href="Log.html"><title>Log</title> +</head> +<body> +<code class="code"><span class="keyword">sig</span><br> + <span class="keyword">type</span> privacy_level = <span class="constructor">Private</span> <span class="keywordsign">|</span> <span class="constructor">Semi_private</span> <span class="keywordsign">|</span> <span class="constructor">Public</span><br> + <span class="keyword">type</span> item = <span class="constructor">Item</span> <span class="keyword">of</span> <span class="constructor">Log</span>.privacy_level * string * string<br> + <span class="keyword">type</span> log_entry = <span class="constructor">Log_entry</span> <span class="keyword">of</span> <span class="constructor">Ptime</span>.date * string * <span class="constructor">Log</span>.item list<br> + <span class="keyword">type</span> log = <span class="constructor">Log</span>.log_entry list<br> + <span class="keyword">val</span> compatible_privacy : <span class="constructor">Log</span>.privacy_level <span class="keywordsign">-></span> <span class="constructor">Log</span>.privacy_level <span class="keywordsign">-></span> bool<br> + <span class="keyword">val</span> privacy_level_of_char : char <span class="keywordsign">-></span> <span class="constructor">Log</span>.privacy_level option<br> + <span class="keyword">val</span> filter_privacy_level :<br> + <span class="constructor">Log</span>.privacy_level <span class="keywordsign">-></span> <span class="constructor">Log</span>.item list <span class="keywordsign">-></span> <span class="constructor">Log</span>.item list<br> + <span class="keyword">val</span> log_parser : <span class="constructor">Log</span>.log <span class="constructor">Angstrom</span>.t<br> +<span class="keyword">end</span></code></body></html> \ No newline at end of file |