Documentation updates for 0.5.0

davebalmer · Nov 25, 2013 · bdc2045 · bdc2045
1 parent 5ddcb40
commit bdc2045
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 6 deletions.
diff --git a/docs/classhierarchy.mdown b/docs/classhierarchy.mdown
@@ -29,6 +29,7 @@ User Interface
 	* joControl
 		* joButton
 			* joBackButton
+		* joCanvas
 		* joCaption
 		* joExpando
 			* joSelect
@@ -43,7 +44,6 @@ User Interface
 			* joSelectList
 			* joTabBar
 			* joTable
-		* joKnob
 		* joSlider
 		* joToggle
 		* joOption
@@ -75,7 +75,7 @@ Processing
 
 * joChain
 * joDefer
-* joWait
+* joQueue
 
 Utility
 -------
@@ -85,7 +85,9 @@ Utility
 * joJSON
 * joLocal
 * joString
+* joTemplate
 * joTime
+* joTimer
 
 Debugging
 ---------

diff --git a/docs/releasenotes.mdown b/docs/releasenotes.mdown
@@ -22,6 +22,7 @@ Jo 0.5.0 "Pumpkin Spice"
 - New joCanvas widget, a basic canvas tag wrapper
 - New joImage widget
 - New joTemplate class for simple string templating
+- Added placeholder support to joInput
 
 Jo 0.4.1
 --------

diff --git a/js/ui/canvas.js b/js/ui/canvas.js
@@ -1,3 +1,9 @@
+/**
+	joCanvas
+	========
+
+	Simple canvas wrapper control.
+*/
 
 function joCanvas(w, h) {
 	this.canvas = joDOM.create("canvas");

diff --git a/js/ui/gesture.js b/js/ui/gesture.js
@@ -13,7 +13,9 @@
 	
 	- `backEvent`
 
-	  Fired when `ESC` key is pressed (on webOS, the back gesture fires an `ESC` key)
+	  Fired when `ESC` key is pressed (on webOS, the back gesture fires an `ESC` key),
+	  also used to hook in hardware back buttons for different platforms (e.g.
+	  Tizen, Android).
 	
 	- `resizeEvent`
 	

diff --git a/js/ui/input.js b/js/ui/input.js
@@ -12,14 +12,17 @@
 		// simple value, simple field
 		var x = new joInput(a);
 		
-		// set up a simple joRecord instance with some default data
+		// OR set up a simple joRecord instance with some default data
 		var pref = new joRecord({
 			username: "Bob",
 			password: "password"
 		});
 				
-		// attach the value to a data structure property
+		// AND attach the value to a data structure property
 		var y = new joInput(pref.link("username"));
+
+		// set an input with a placehlder string
+		var z = new joInput(b, "Placeholder");
 	
 	Extends
 	-------

diff --git a/makedoc b/makedoc
@@ -1,5 +1,5 @@
 #!/bin/bash
-#../joDoc/jodoc --toc ~/Projects/jodocs/contents.mdown --template ~/Projects/jodocs/template.html --title "Jo HTML5 Mobile JavaScript Framework" --output ~/Projects/jodocs/docs ABOUT.mdown LICENSE.mdown README.mdown js/core/*.js js/data/*.js js/ui/*.js docs/*.mdown
+#../joDoc/jodoc --toc ~/Projects/jodocs/contents.mdown --template ~/Projects/jodocs/template.html --title "Jo HTML5 Mobile JavaScript Framework 0.5.0" --output ~/Projects/jodocs/docs ABOUT.mdown LICENSE.mdown README.mdown js/core/*.js js/data/*.js js/ui/*.js docs/*.mdown
 #cat ABOUT.mdown README.mdown docs/*.mdown LICENSE.mdown > /tmp/jo.mdown
 #cat js/core/*.js js/data/*.js js/ui/*.js > /tmp/jo.js
 #../joDoc/jodoc --template ~/Projects/jodocs/singletemplate.html --title "Jo HTML5 Mobile JavaScript Framework" /tmp/jo.js /tmp/jo.mdown > ~/Projects/jodocs/docs/singlepage.html