diff --git a/doc/SQLite370.svg b/doc/SQLite370.svg new file mode 100644 index 0000000..424e0ab --- /dev/null +++ b/doc/SQLite370.svg @@ -0,0 +1,67 @@ + + + +SQLiteimage/svg+xmlSQLite \ No newline at end of file diff --git a/doc/overview.edoc b/doc/overview.edoc index 5428e27..8ca56be 100644 --- a/doc/overview.edoc +++ b/doc/overview.edoc @@ -1,10 +1,10 @@ @author Maas-Maarten Zeeman -@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.
diff --git a/doc/style.css b/doc/style.css new file mode 100644 index 0000000..ad59351 --- /dev/null +++ b/doc/style.css @@ -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; +} diff --git a/rebar.config.script b/rebar.config.script index 8615bf0..435ce86 100644 --- a/rebar.config.script +++ b/rebar.config.script @@ -68,6 +68,7 @@ CFlags = ]}, {edoc_opts, [{preprocess, true}, + {stylesheet, "style.css"}, {sort_functions, false}]}, {hex, [{doc, edoc}]} diff --git a/src/esqlite3.erl b/src/esqlite3.erl index f226c26..ea86db8 100644 --- a/src/esqlite3.erl +++ b/src/esqlite3.erl @@ -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]).