Documentation

doc/jsdoc/db.md

@@ -1,25 +1,18 @@
-#db
+# db
 `require("./db");`
 
-2011 Peter 'Pita' Martischka
-* Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-*      http://www.apache.org/licenses/LICENSE-2.0
-* Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS-IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+The DB Module provides a database initalized with the settings 
+provided by the settings module
 
-##Functions
+## Functions
 
-###init (callback)
+### init (callback)
+Initalizes the database with the settings provided by the settings module
 
-* **callback** 
+* **callback** *(Function)* *No description*
 
 ##Variables
 
-###db 
-
+### db 
+The UeberDB Object that provides the database functions