Updated api documentation

3 files changed, 101 insertions, 81 deletions

diff --git a/api/dwb-js.7 b/api/dwb-js.7
index 842daff8..a963bf0d 100644
--- a/api/dwb-js.7
+++ b/api/dwb-js.7
@@ -2,12 +2,12 @@
 .\"     Title: dwb-js
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.77.1 <http://docbook.sf.net/>
-.\"      Date: 11/01/2012
+.\"      Date: 11/02/2012
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "DWB\-JS" "7" "11/01/2012" "\ \&" "\ \&"
+.TH "DWB\-JS" "7" "11/02/2012" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -970,24 +970,19 @@ The object forEach is called on
 .nr an-break-flag 1
 .br
 .ps +1
-\fBvoid Object.setPrivate(String key, String value, Object identifier)\fR
+\fBNumber Array.fastIndexOf(Object object)\fR
 .RS 4
 .sp
-Associates a private value with that object that can only be retrieved in the calling script, this function is only useful for objects derived from GObjects, e\&.g\&. to associate a value with a webview and keep it invisible in other scripts\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
+This method is basically the same as Array\&.indexOf but without type checking\&.
 .PP
-\fIvalue\fR
+\fIobject\fR
 .RS 4
-The property value
+The object to search for
 .RE
 .PP
-\fIidentifier\fR
+\fIreturns\fR
 .RS 4
-A local object to identify the calling script, the identifier must either be of type Object or of type Function\&.
+The index in the array or \-1 if the Object wasn\(cqt found\&.
 .RE
 .RE
 .sp
@@ -996,24 +991,19 @@ A local object to identify the calling script, the identifier must either be of
 .nr an-break-flag 1
 .br
 .ps +1
-\fBObject Object.getPrivate(String key, Object identifier)\fR
+\fBNumber Array.fastLastIndexOf(Object object)\fR
 .RS 4
 .sp
-Gets a value previously set with Object\&.setPrivate\&.
-.PP
-\fIkey\fR
-.RS 4
-The property name
-.RE
+This method is basically the same as Array\&.lastIndexOf but without type checking\&.
 .PP
-\fIidentifier\fR
+\fIobject\fR
 .RS 4
-The identifier passed to setPrivate
+The object to search for
 .RE
 .PP
 \fIreturns\fR
 .RS 4
-The object set with setPrivate or null\&.
+The index in the array or \-1 if the Object wasn\(cqt found\&.
 .RE
 .RE
 .sp
@@ -1022,19 +1012,24 @@ The object set with setPrivate or null\&.
 .nr an-break-flag 1
 .br
 .ps +1
-\fBNumber Array.fastIndexOf(Object object)\fR
+\fBObject Object.getPrivate(String key, Object identifier)\fR
 .RS 4
 .sp
-This method is basically the same as Array\&.indexOf but without type checking\&.
+Gets a value previously set with Object\&.setPrivate\&.
 .PP
-\fIobject\fR
+\fIkey\fR
 .RS 4
-The object to search for
+The property name
+.RE
+.PP
+\fIidentifier\fR
+.RS 4
+The identifier passed to setPrivate
 .RE
 .PP
 \fIreturns\fR
 .RS 4
-The index in the array or \-1 if the Object wasn\(cqt found\&.
+The object set with setPrivate or null\&.
 .RE
 .RE
 .sp
@@ -1043,19 +1038,24 @@ The index in the array or \-1 if the Object wasn\(cqt found\&.
 .nr an-break-flag 1
 .br
 .ps +1
-\fBNumber Array.fastLastIndexOf(Object object)\fR
+\fBvoid Object.setPrivate(String key, String value, Object identifier)\fR
 .RS 4
 .sp
-This method is basically the same as Array\&.lastIndexOf but without type checking\&.
+Associates a private value with that object that can only be retrieved in the calling script, this function is only useful for objects derived from GObjects, e\&.g\&. to associate a value with a webview and keep it invisible in other scripts\&.
 .PP
-\fIobject\fR
+\fIkey\fR
 .RS 4
-The object to search for
+The property name
 .RE
 .PP
-\fIreturns\fR
+\fIvalue\fR
 .RS 4
-The index in the array or \-1 if the Object wasn\(cqt found\&.
+The property value
+.RE
+.PP
+\fIidentifier\fR
+.RS 4
+A local object to identify the calling script, the identifier must either be of type Object or of type Function\&.
 .RE
 .RE
 .SH "WEBKIT OBJECTS"
diff --git a/api/jsapi.7.txt b/api/jsapi.7.txt
index cc1a8bb6..7833d11f 100644
--- a/api/jsapi.7.txt
+++ b/api/jsapi.7.txt
@@ -442,17 +442,22 @@ _value_;; The property value
 _this_;; The object forEach is called on
 ****
 
-==== void Object.setPrivate(String key, String value, Object identifier)
+==== Number Array.fastIndexOf(Object object)
 ****
 
-Associates a private value with that object that can only be retrieved in the
-calling script, this function is only useful for objects derived from GObjects,
-e.g. to associate a value with a webview and keep it invisible in other scripts.
+This method is basically the same as Array.indexOf but without type checking.
 
-_key_;; The property name
-_value_;; The property value
-_identifier_;; A local object to identify the calling script, the identifier
-must either be of type Object or of type Function.
+_object_;; The object to search for
+_returns_;; The index in the array or -1 if the Object wasn't found.
+****
+
+==== Number Array.fastLastIndexOf(Object object)
+****
+
+This method is basically the same as Array.lastIndexOf but without type checking.
+
+_object_;; The object to search for
+_returns_;; The index in the array or -1 if the Object wasn't found.
 ****
 
 ==== Object Object.getPrivate(String key, Object identifier)
@@ -465,26 +470,23 @@ _identifier_;; The identifier passed to setPrivate
 _returns_;; The object set with setPrivate or null.
 ****
 
-==== Number Array.fastIndexOf(Object object)
-****
-
-This method is basically the same as Array.indexOf but without type checking.
 
-_object_;; The object to search for
-_returns_;; The index in the array or -1 if the Object wasn't found.
-****
-
-==== Number Array.fastLastIndexOf(Object object)
+==== void Object.setPrivate(String key, String value, Object identifier)
 ****
 
-This method is basically the same as Array.lastIndexOf but without type checking.
+Associates a private value with that object that can only be retrieved in the
+calling script, this function is only useful for objects derived from GObjects,
+e.g. to associate a value with a webview and keep it invisible in other scripts.
 
-_object_;; The object to search for
-_returns_;; The index in the array or -1 if the Object wasn't found.
+_key_;; The property name
+_value_;; The property value
+_identifier_;; A local object to identify the calling script, the identifier
+must either be of type Object or of type Function.
 ****
 
 
 
+
 == WEBKIT OBJECTS ==
 
 All webkit objects correspond to gobject objects, i.e. they have the same
diff --git a/api/jsapi.txt b/api/jsapi.txt
index 993fcec3..38df9601 100644
--- a/api/jsapi.txt
+++ b/api/jsapi.txt
@@ -824,24 +824,37 @@ _this_;; The object forEach is called on
 ****
 
 ****
-[[setPrivate]]
+[[fastIndexOf]]
 [float]
-==== *Object.setPrivate()* ==== 
+==== *Array.fastIndexOf()* ==== 
 [source,javascript]
 ----
-void Object.setPrivate(key, value, identifier)
+Number Array.fastIndexOf(Object object)
 ----
 
-Associates a private value with that object that can only be retrieved in the
-calling script, this function is only useful for objects derived from GObjects,
-e.g. to associate a value with a webview and keep it invisible in other scripts.
+This method is basically the same as +Array.indexOf+ but without type checking.
 
  :: 
 
-_key_;; The property name
-_value_;; The property value
-_identifier_;; A local object to identify the calling script, the identifier
-must either be of type object or of type function.
+_object_;; The object to search for
+_returns_;; The index in the array or +-1+ if the Object wasn't found.
+****
+
+****
+[[fastLastIndexOf]]
+[float]
+==== *Array.fastLastIndexOf()* ==== 
+[source,javascript]
+----
+Number Array.fastLastIndexOf(Object object)
+----
+
+This method is basically the same as +Array.lastIndexOf+ but without type checking.
+
+ :: 
+
+_object_;; The object to search for
+_returns_;; The index in the array or +-1+ if the Object wasn't found.
 ****
 
 ****
@@ -863,38 +876,43 @@ _returns_;; The object set with <<setPrivate>> or +null+.
 ****
 
 ****
-[[fastIndexOf]]
+[[setPrivate]]
 [float]
-==== *Array.fastIndexOf()* ==== 
+==== *Object.setPrivate()* ==== 
 [source,javascript]
 ----
-Number Array.fastIndexOf(Object object)
+void Object.setPrivate(key, value, identifier)
 ----
 
-This method is basically the same as +Array.indexOf+ but without type checking.
+Associates a private value with that object that can only be retrieved in the
+calling script, this function is only useful for objects derived from GObjects,
+e.g. to associate a value with a webview and keep it invisible in other scripts.
 
  :: 
 
-_object_;; The object to search for
-_returns_;; The index in the array or +-1+ if the Object wasn't found.
+_key_;; The property name
+_value_;; The property value
+_identifier_;; A local object to identify the calling script, the identifier
+must either be of type object or of type function.
 ****
 
-****
-[[fastLastIndexOf]]
+====
 [float]
-==== *Array.fastLastIndexOf()* ==== 
+==== *Example* ====
 [source,javascript]
-----
-Number Array.fastLastIndexOf(Object object)
-----
+------------
+var self = this;
+signals.connect("loadCommitted", function(wv) {
+  wv.setPrivate("foo", "bar", self);
+});
+signals.connect("loadFinished", function(wv) {
+  io.print(wv.getPrivate("foo", self));
+});
+------------
+====
 
-This method is basically the same as +Array.lastIndexOf+ but without type checking.
 
- :: 
 
-_object_;; The object to search for
-_returns_;; The index in the array or +-1+ if the Object wasn't found.
-****
 
 [[Webkitobjects]]
 == Webkit objects ==