yoxem/stringCodepointSplitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

modified the readme and remove the generated docs

Browse source
This commit is contained in:
Tan, Kian-ting 2023-08-27 12:29:31 +08:00
parent 11d968eb04
commit ede161c54f
16 changed files with 25 additions and 310 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGES Normal file
View file

@ -0,0 +1,2 @@
## 0.0.1
- 2023-08-27 : add `split_string_by_unicode_codepoint` initially

24
README.md
View file

@ -4,8 +4,30 @@ Split a string to a list of strings of a character by the unicode codepoint.
It requires module Uutf.
for documantations, see `docs`
## Dependencies
- OCaml >= 4.13
- dune
- uutf
- fildlib
## Install
```
$ cd /path/to/stringCodepointSplitter
$ dune build
$ dune install
```
## Generate Docs
```
$ dune build @doc
```
Generated documentations will be in `/path/to/stringCodepointSplitter/_build/default/_doc` in
various formats, incl. html.
## Example
```OCaml

41
docs/StringCodepointSplitter.html
View file

@ -1,41 +0,0 @@
<!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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>StringCodepointSplitter</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Module <a href="type_StringCodepointSplitter.html">StringCodepointSplitter</a></h1>
<pre><span id="MODULEStringCodepointSplitter"><span class="keyword">module</span> StringCodepointSplitter</span>: <code class="code">sig</code> <a href="StringCodepointSplitter.html">..</a> <code class="code">end</code></pre><hr width="100%">
<p>The Module needs <code class="code">Uutf</code> Module.</p>
<p>It only contains <code class="code">split_string_by_unicode_codepoint</code>, which splits an OCaml string <code class="code">str</code> to a <code class="code">string list</code></p>
<pre><span id="VALsplit_string_by_unicode_codepoint"><span class="keyword">val</span> split_string_by_unicode_codepoint</span> : <code class="type">string -&gt; string list</code></pre><div class="info ">
<div class="info-desc">
<p>Split an OCaml string <code class="code">str</code> to a <code class="code">string list</code></p>
<p><b>Arguments</b></p>
<ul>
<li><code class="code">str</code> the string to be splitted.
</li>
</ul>
<p><b>Example</b></p>
<pre class="codepre"><code class="code">let example= "m̄知 who you're." (*don't know who you are*) in
List.map (fun x -&gt; print_string (x ^ ", ")) (split_string_by_unicode_codepoint example);;
(*it will output : "m, ̄, 知, , w, h, o, , y, o, u, ', r, e, ., "*)</code></pre></div>
</div>
</body></html>

24
docs/index.html
View file

@ -1,24 +0,0 @@
<!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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title></title>
</head>
<body>
<div class = "index-list">
<ul class="indexlist">
<li><a href="index_values.html">Index of values</a></li>
<li><a href="index_modules.html">Index of modules</a></li>
</ul>
</div>
<table class="indextable module-list">
<tr><td class="module"><a href="StringCodepointSplitter.html">StringCodepointSplitter</a></td><td></td></tr>
</table>
</body>
</html>

18
docs/index_attributes.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of class attributes</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of class attributes</h1>
<table>
</table>
</body>
</html>

18
docs/index_class_types.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of class types</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of class types</h1>
<table>
</table>
</body>
</html>

18
docs/index_classes.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of classes</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of classes</h1>
<table>
</table>
</body>
</html>

18
docs/index_exceptions.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of exceptions</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of exceptions</h1>
<table>
</table>
</body>
</html>

18
docs/index_extensions.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of extensions</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of extensions</h1>
<table>
</table>
</body>
</html>

18
docs/index_methods.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of class methods</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of class methods</h1>
<table>
</table>
</body>
</html>

18
docs/index_module_types.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of module types</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of module types</h1>
<table>
</table>
</body>
</html>

21
docs/index_modules.html
View file

@ -1,21 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of modules</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of modules</h1>
<table>
<tr><td align="left"><div>S</div></td></tr>
<tr><td><a href="StringCodepointSplitter.html">StringCodepointSplitter</a> </td>
<td></td></tr>
</table>
</body>
</html>

18
docs/index_types.html
View file

@ -1,18 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of types</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of types</h1>
<table>
</table>
</body>
</html>

25
docs/index_values.html
View file

@ -1,25 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>Index of values</title>
</head>
<body>
<div class="navbar">&nbsp;<a class="up" href="index.html" title="Index">Up</a>
&nbsp;</div>
<h1>Index of values</h1>
<table>
<tr><td align="left"><div>S</div></td></tr>
<tr><td><a href="StringCodepointSplitter.html#VALsplit_string_by_unicode_codepoint">split_string_by_unicode_codepoint</a> [<a href="StringCodepointSplitter.html">StringCodepointSplitter</a>]</td>
<td><div class="info">
<p>Split an OCaml string <code class="code">str</code> to a <code class="code">string list</code></p>
</div>
</td></tr>
</table>
</body>
</html>

43
docs/style.css
View file

@ -1,43 +0,0 @@
.keyword { font-weight : bold ; color : Red }
.keywordsign { color : #C04600 }
.comment { color : Green }
.constructor { color : Blue }
.type { color : #5C6585 }
.string { color : Maroon }
.warning { color : Red ; font-weight : bold }
.info { margin-left : 3em; margin-right: 3em }
.param_info { margin-top: 4px; margin-left : 3em; margin-right : 3em }
.code { color : #465F91 ; }
.typetable { border-style : hidden }
.paramstable { border-style : hidden ; padding: 5pt 5pt}
tr { background-color : White }
td.typefieldcomment { background-color : #FFFFFF ; font-size: smaller ;}
div.sig_block {margin-left: 2em}
*:target { background: yellow; }
body {font: 13px sans-serif; color: black; text-align: left; padding: 5px; margin: 0}
h1 { font-size : 20pt ; text-align: center; }
h2 { font-size : 20pt ; text-align: center; }
h3 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ;padding: 2px; }
h4 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90DDFF ;padding: 2px; }
h5 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90EDFF ;padding: 2px; }
h6 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90FDFF ;padding: 2px; }
div.h7 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ; padding: 2px; }
div.h8 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #E0FFFF ; padding: 2px; }
div.h9 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #F0FFFF ; padding: 2px; }
div.h10 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #FFFFFF ; padding: 2px; }
a {color: #416DFF; text-decoration: none}
a:hover {background-color: #ddd; text-decoration: underline}
pre { margin-bottom: 4px; font-family: monospace; }
pre.verbatim, pre.codepre { }
.indextable {border: 1px #ddd solid; border-collapse: collapse}
.indextable td, .indextable th {border: 1px #ddd solid; min-width: 80px}
.indextable td.module {background-color: #eee ; padding-left: 2px; padding-right: 2px}
.indextable td.module a {color: #4E6272; text-decoration: none; display: block; width: 100%}
.indextable td.module a:hover {text-decoration: underline; background-color: transparent}
.deprecated {color: #888; font-style: italic}
.indextable tr td div.info { margin-left: 2px; margin-right: 2px }
ul.indexlist { margin-left: 0; padding-left: 0;}
ul.indexlist li { list-style-type: none ; margin-left: 0; padding-left: 0; }
ul.info-attributes {list-style: none; margin: 0; padding: 0; }
div.info > p:first-child { margin-top:0; }
div.info-desc > p:first-child { margin-top:0; margin-bottom:0; }

11
docs/type_StringCodepointSplitter.html
View file

@ -1,11 +0,0 @@
<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 values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="StringCodepointSplitter" rel="Chapter" href="StringCodepointSplitter.html"><title>StringCodepointSplitter</title>
</head>
<body>
<code class="code"><span class="keyword">sig</span>&nbsp;<span class="keyword">end</span></code></body></html>