Improve documentation

Author: lovasoa

.jsdoc.config.json

@@ -9,6 +9,29 @@
     },
     "opts": {
         "encoding": "utf8",
-        "destination": "./documentation/"   
+        "destination": "./documentation/",
+        "readme": "documentation_index.md",
+        "template": "./node_modules/clean-jsdoc-theme",
+        "theme_opts": {
+            "title": "sql.js",
+            "meta": [
+                "<meta name=\"author\" content=\"Ophir Lojkine\">",
+                "<meta name=\"description\" content=\"sql.js technical documentation\">"
+            ],
+            "menu": [
+                {
+                    "title": "Website",
+                    "link": "https://sql.js.org/"
+                },
+                {
+                    "title": "Github",
+                    "link": "https://github.com/sql-js/sql.js"
+                },
+                {
+                    "title": "Demo",
+                    "link": "https://sql.js.org/examples/GUI/"
+                }
+            ]
+        }
     }
 }

README.md

@@ -15,7 +15,8 @@ sql.js can be used like any traditional JavaScript library. If you are building
 SQLite is public domain, sql.js is MIT licensed.
 
 ## API documentation
-A [full API documentation](https://sql.js.org/documentation/class/Database.html) generated from comments inside the source code is available.
+A [full API documentation](https://sql.js.org/documentation/) for all the available classes and methods is available.
+Is is generated from comments inside the source code, and is thus always up to date.
 
 ## Usage
 
@@ -37,19 +38,6 @@ var db = new SQL.Database();
 // NOTE: You can also use new SQL.Database(data) where
 // data is an Uint8Array representing an SQLite database file
 
-// Execute some sql
-sqlstr = "CREATE TABLE hello (a int, b char);";
-sqlstr += "INSERT INTO hello VALUES (0, 'hello');"
-sqlstr += "INSERT INTO hello VALUES (1, 'world');"
-db.run(sqlstr); // Run the query without returning anything
-
-var res = db.exec("SELECT * FROM hello");
-/*
-[
-  {columns:['a','b'], values:[[0,'hello'],[1,'world']]}
-]
-*/
-
 // Prepare an sql statement
 var stmt = db.prepare("SELECT * FROM hello WHERE a=:aval AND b=:bval");
 
@@ -65,6 +53,19 @@ stmt.free();
 // You can not use your statement anymore once it has been freed.
 // But not freeing your statements causes memory leaks. You don't want that.
 
+// Execute a single SQL string that contains multiple statements
+sqlstr = "CREATE TABLE hello (a int, b char);";
+sqlstr += "INSERT INTO hello VALUES (0, 'hello');"
+sqlstr += "INSERT INTO hello VALUES (1, 'world');"
+db.run(sqlstr); // Run the query without returning anything
+
+var res = db.exec("SELECT * FROM hello");
+/*
+[
+  {columns:['a','b'], values:[[0,'hello'],[1,'world']]}
+]
+*/
+
 // You can also use JavaScript functions inside your SQL code
 // Create the js function you need
 function add(a, b) {return a+b;}

documentation_index.md

@@ -0,0 +1,26 @@
+# sql.js API documentation
+
+## Introduction
+
+If you need a quick intoduction with code samples that you can copy-and-paste,
+head over to [sql.js.org](https://sql.js.org/)
+
+## API
+
+### The initSqlJs function
+
+The root object in the API is the [`initSqlJs`](./global.html#initSqlJs) function,
+that takes an [`SqlJsConfig`](./global.html#SqlJsConfig) parameter,
+and returns an [SqlJs](./global.html#SqlJs) object
+
+### The SqlJs object
+
+`initSqlJs` returns the main sql.js object, the [**`SqlJs`**](./module-SqlJs.html) module, which contains :
+
+#### Database
+
+[**Database**](./Database.html) is the main class, that represents an SQLite database.
+
+#### Statement
+
+The [**Statement**](./Statement.html) class is used for prepared statements.

package-lock.json

@@ -40,6 +40,7 @@
 		"url": "https://github.com/sql-js/sql.js/issues"
 	},
 	"devDependencies": {
+		"clean-jsdoc-theme": "^2.2.14",
 		"eslint": "^6.8.0",
 		"eslint-config-airbnb-base": "^14.2.0",
 		"eslint-plugin-import": "^2.22.1",

package.json

@@ -23,8 +23,9 @@
 "use strict";
 
 /**
- * @typedef {{Database:Database}} SqlJs
- * @property {Database} Database the database constructor
+ * @typedef {{Database:Database, Statement:Statement}} SqlJs
+ * @property {Database} Database A class that represents an SQLite database
+ * @property {Statement} Statement The prepared statement class
  */
 
 /**