From da02feb2d2c768e8dd2d3adcca1626fc12821823 Mon Sep 17 00:00:00 2001 From: Timothy Warren Date: Thu, 12 Apr 2012 13:00:55 -0400 Subject: [PATCH] docs cleanup --- docs/images/bg.png | Bin docs/images/class_default_obj.png | Bin docs/images/class_obj.png | Bin docs/images/collapsebtn.gif | Bin docs/images/expandbtn.gif | Bin docs/images/field_private_obj.png | Bin docs/images/field_public_obj.png | Bin docs/images/file_obj.png | Bin docs/images/method_private_obj.png | Bin docs/images/method_public_obj.png | Bin docs/images/minus.gif | Bin docs/images/namespace_function_obj.png | Bin docs/images/namespace_obj.png | Bin docs/images/never_translate.png | Bin docs/images/plus.gif | Bin docs/symbols/$_.indexedDB.html | 1 - .../src/kis-js_src_modules_indexedDB.js.html | 122 ------------------ 17 files changed, 123 deletions(-) mode change 100755 => 100644 docs/images/bg.png mode change 100755 => 100644 docs/images/class_default_obj.png mode change 100755 => 100644 docs/images/class_obj.png mode change 100755 => 100644 docs/images/collapsebtn.gif mode change 100755 => 100644 docs/images/expandbtn.gif mode change 100755 => 100644 docs/images/field_private_obj.png mode change 100755 => 100644 docs/images/field_public_obj.png mode change 100755 => 100644 docs/images/file_obj.png mode change 100755 => 100644 docs/images/method_private_obj.png mode change 100755 => 100644 docs/images/method_public_obj.png mode change 100755 => 100644 docs/images/minus.gif mode change 100755 => 100644 docs/images/namespace_function_obj.png mode change 100755 => 100644 docs/images/namespace_obj.png mode change 100755 => 100644 docs/images/never_translate.png mode change 100755 => 100644 docs/images/plus.gif delete mode 100755 docs/symbols/$_.indexedDB.html delete mode 100755 docs/symbols/src/kis-js_src_modules_indexedDB.js.html diff --git a/docs/images/bg.png b/docs/images/bg.png old mode 100755 new mode 100644 diff --git a/docs/images/class_default_obj.png b/docs/images/class_default_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/class_obj.png b/docs/images/class_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/collapsebtn.gif b/docs/images/collapsebtn.gif old mode 100755 new mode 100644 diff --git a/docs/images/expandbtn.gif b/docs/images/expandbtn.gif old mode 100755 new mode 100644 diff --git a/docs/images/field_private_obj.png b/docs/images/field_private_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/field_public_obj.png b/docs/images/field_public_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/file_obj.png b/docs/images/file_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/method_private_obj.png b/docs/images/method_private_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/method_public_obj.png b/docs/images/method_public_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/minus.gif b/docs/images/minus.gif old mode 100755 new mode 100644 diff --git a/docs/images/namespace_function_obj.png b/docs/images/namespace_function_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/namespace_obj.png b/docs/images/namespace_obj.png old mode 100755 new mode 100644 diff --git a/docs/images/never_translate.png b/docs/images/never_translate.png old mode 100755 new mode 100644 diff --git a/docs/images/plus.gif b/docs/images/plus.gif old mode 100755 new mode 100644 diff --git a/docs/symbols/$_.indexedDB.html b/docs/symbols/$_.indexedDB.html deleted file mode 100755 index cfd638f..0000000 --- a/docs/symbols/$_.indexedDB.html +++ /dev/null @@ -1 +0,0 @@ -JsDoc Reference - $_.indexedDB
 
Project Outline
 
$_
dom
store
indexedDB
util
event
$(string, object)
ext(string, object)
each(function)
type(mixed)
get(string, object, function)
post(string, object, function)
sse(string, function, int)
 
$_.dom
addClass(string)
removeClass(string)
hide()
show(string)
attr(string, string)
text(string)
css(string, string)
append(string)
prepend(string)
html(string)
 
$_.event
add(string, function)
remove(string, string)
live(string, string, function)
delegate(string, string, function)
 
$_.indexedDB
connect(string, int, function)
create_store(string, string, bool)
delete_store(string)
 
$_.store
get(string, bool)
set(string, mixed, bool)
remove(string, bool)
getAll(bool)
clear(bool)
 
$_.util
object_keys(object)
object_values(object)
array_combine(array/object, array/object)
object_merge(object)
str_trans(string, mixed, string)
 
_global_
«
Kis JS Docs

Module $_.indexedDB

Defined in: indexedDB.js.

Method Summary
connect(string, int, function)Connects to an indexedDB database
create_store(string, string, bool)Helper function to create a new object store
delete_store(string)Delete an object store
Method Detail
$_.indexedDB.connect(string, int, function)
Connects to an indexedDB database 
Parameters:
string dbname 
int?, Default:  version 
function?, Default:  onupgradeneeded 
 $_.indexedDB.create_store(string, string, bool)
 Helper function to create a new object store 
Parameters:
string name 
string?, Default:  key 
bool?, Default:  generator 
Returns:
 IDBDataStore object 
 $_.indexedDB.delete_store(string)
 Delete an object store 
Parameters:
string name 
 
\ No newline at end of file
diff --git a/docs/symbols/src/kis-js_src_modules_indexedDB.js.html b/docs/symbols/src/kis-js_src_modules_indexedDB.js.html
deleted file mode 100755
index 5c7a317..0000000
--- a/docs/symbols/src/kis-js_src_modules_indexedDB.js.html
+++ /dev/null
@@ -1,122 +0,0 @@
- 
  1 /**
-  2  * Module for simplifying Indexed DB access
-  3  */
-  4 (function (){
-  5 	"use strict";
-  6 	
-  7 	var db = window.indexedDB || window.webkitIndexedDB || window.mozIndexedDB || window.msIndexedDB,
-  8 		indexedDB = {};
-  9 		
- 10 	//Well, some browsers don't support it yet
- 11 	if(typeof db === "undefined")
- 12 	{
- 13 		return;
- 14 	}
- 15 
- 16 	/**
- 17 	 * Module for simplifying Indexed DB access
- 18 	 *
- 19 	 * @namespace
- 20 	 * @name indexedDB
- 21 	 * @memberOf $_
- 22 	 */
- 23 	indexedDB = {
- 24 		current_db: null,
- 25 		/**
- 26 		 * Connects to an indexedDB database
- 27 		 *
- 28 		 * @memberOf $_.indexedDB
- 29 		 * @name connect
- 30 		 * @function
- 31 		 * @param string dbname
- 32 		 * @param [int] version
- 33 		 * @param [function] onupgradeneeded
- 34 		 */
- 35 		connect: function(dbname, version, onupgradeneeded)
- 36 		{
- 37 			var request = {};
- 38 		
- 39 			version = version || 1;
- 40 			
- 41 			// Ask for permission to use db
- 42 			request = db.open(dbname, version);
- 43 			
- 44 			// Assign onupgradeneeded callback
- 45 			if(typeof onupgradeneeded !== "undefined")
- 46 			{
- 47 				request.onupgradeneeded = onupgradeneeded;
- 48 			}
- 49 			
- 50 			/**
- 51 			 * @private
- 52 			 */	
- 53 			request.onerror = function(event)
- 54 			{
- 55 				console.log("IndexedDB disallowed.");
- 56 			};
- 57 			
- 58 			/**
- 59 			 * @private
- 60 			 */
- 61 			request.onsuccess = function(event)
- 62 			{
- 63 				// Connect to the specified db
- 64 				indexedDB.current_db = request.result;
- 65 			};
- 66 		},
- 67 		/**
- 68 		 * Helper function to create a new object store
- 69 		 *
- 70 		 * @memberOf $_.indexedDB
- 71 		 * @name create_store
- 72 		 * @function
- 73 		 * @param string name
- 74 		 * @param [string] key
- 75 		 * @param [bool] generator
- 76 		 * @return IDBDataStore object
- 77 		 */
- 78 		create_store: function(name, key, generator)
- 79 		{
- 80 			var params = {};
- 81 				
- 82 			if(typeof key !== "undefined")
- 83 			{
- 84 				params.keyPath = key;
- 85 			}
- 86 			
- 87 			if(typeof generator !== "undefined")
- 88 			{
- 89 				// Cast to a boolean value
- 90 				params.autoIncrement = !! generator;
- 91 			}
- 92 			
- 93 			return db.createObjectStore(name, params);
- 94 		},
- 95 		/**
- 96 		 * Delete an object store
- 97 		 *
- 98 		 * @memberOf $_.indexedDB
- 99 		 * @name delete_store
-100 		 * @function
-101 		 * @param string name
-102 		 */
-103 		delete_store: function(name)
-104 		{
-105 			var request = db.deleteObjectStore();
-106 			
-107 			// Pass the error up
-108 			request.onerror = db.onerror;
-109 		}
-110 		 
-111 	};
-112 	
-113 	$_.ext('indexedDB', indexedDB);
-114 	
-115 }());

\ No newline at end of file