Documentation tweaks

This commit is contained in:
Maas-Maarten Zeeman
2022-05-27 09:38:24 +02:00
parent f383499868
commit e831ba0a33
5 changed files with 148 additions and 4 deletions

67
doc/SQLite370.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 9.7 KiB

View File

@@ -1,10 +1,10 @@
@author Maas-Maarten Zeeman <mmzeeman@xs4all.nl>
@title eSqlite Documentation
@title ESQLite Documentation
@doc
eSqlite is a library which makes it possible to use sqlite databases in erlang. It is implemented
ESQLite is a library which makes it possible to use sqlite databases in erlang. It is implemented
as a NIF, which means that the sqlite database engine is linked to the erlang virtual machine.
<hr />

76
doc/style.css Normal file
View File

@@ -0,0 +1,76 @@
/* standard EDoc style sheet */
body {
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
margin-left: .25in;
margin-right: .2in;
margin-top: 0.2in;
margin-bottom: 0.2in;
color: #000000;
background-color: #ffffff;
}
h1,h2 {
margin-left: -0.2in;
}
div.navbar {
background-color: #add8e6;
padding: 0.2em;
}
h2.indextitle {
padding: 0.4em;
background-color: #add8e6;
}
h3.function,h3.typedecl {
background-color: #add8e6;
padding-left: 1em;
}
div.spec {
margin-left: 2em;
background-color: #eeeeee;
}
a.module {
text-decoration:none
}
a.module:hover {
background-color: #eeeeee;
}
ul.definitions {
list-style-type: none;
}
ul.index {
list-style-type: none;
background-color: #eeeeee;
}
/*
* Minor style tweaks
*/
ul {
list-style-type: square;
}
table {
border-collapse: collapse;
}
td {
padding: 3px;
vertical-align: middle;
}
/*
Tune styles
*/
table[summary="navigation bar"] {
background-image: url('SQLite370.svg');
background-size: 110px;
background-repeat: no-repeat;
background-position: center;
}
code, p>tt, a>tt {
font-size: 1.2em;
}
p {
line-height: 1.5;
}

View File

@@ -68,6 +68,7 @@ CFlags =
]},
{edoc_opts, [{preprocess, true},
{stylesheet, "style.css"},
{sort_functions, false}]},
{hex, [{doc, edoc}]}

View File

@@ -102,8 +102,8 @@
%% binary() -> text
-type rowid() :: integer().
-type row() :: tuple(). % tuple of cell_type
-type cell_type() :: undefined | integer() | binary() | float().
-type cell_type() :: undefined | integer() | binary() | float().
-type row() :: list(cell_type()). % tuple of cell_type
-export_type([esqlite3/0, esqlite3_stmt/0, esqlite3_backup/0, prepare_flags/0, sql/0, row/0, rowid/0, cell_type/0]).