Permalink
Browse files

doc fix

  • Loading branch information...
1 parent fdd7884 commit 6bbadcfa64ab2936d7aa613a121bbd18d45ebaa6 @sebv sebv committed Oct 8, 2012
Showing with 48 additions and 48 deletions.
  1. +12 −12 README.md
  2. +12 −12 doc/jsonwire-full-mapping.md
  3. +12 −12 doc/jsonwire-mapping.md
  4. +2 −2 lib/element.js
  5. +10 −10 lib/webdriver.js
View
@@ -425,9 +425,9 @@ browser.init(desired, function() {
<p>
- execute(code, args, cb) -&gt; cb(err, value returned)<br>
+ execute(code, args, cb) -&gt; cb(err, result)<br>
- execute(code, cb) -&gt; cb(err, value returned)<br>
+ execute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -439,9 +439,9 @@ browser.init(desired, function() {
Execute script using eval(code): <br>
- safeExecute(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, args, cb) -&gt; cb(err, result)<br>
- safeExecute(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -483,9 +483,9 @@ browser.init(desired, function() {
<p>
- executeAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, args, cb) -&gt; cb(err, result)<br>
- executeAsync(code, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -497,9 +497,9 @@ browser.init(desired, function() {
Execute async script using eval(code): <br>
- safeExecuteAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, args, cb) -&gt; cb(err, result)<br>
- safeExecuteAsync(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -937,23 +937,23 @@ browser.init(desired, function() {
<p>
- text(element, cb) -&gt; (err, text)<br>
+ text(element, cb) -&gt; cb(err, text)<br>
element: specific element, 'body', or undefined<br>
</p>
<p>
- element.text(cb) -&gt; (err, text)<br>
+ element.text(cb) -&gt; cb(err, text)<br>
</p>
<p>
Check if text is present: <br>
- textPresent(searchText, element, cb) -&gt; (err, boolean)<br>
+ textPresent(searchText, element, cb) -&gt; cb(err, boolean)<br>
element: specific element, 'body', or undefined<br>
@@ -963,7 +963,7 @@ browser.init(desired, function() {
<p>
- element.textPresent(searchText, cb) -&gt; (err, boolean)<br>
+ element.textPresent(searchText, cb) -&gt; cb(err, boolean)<br>
<br>
@@ -342,9 +342,9 @@
<p>
- execute(code, args, cb) -&gt; cb(err, value returned)<br>
+ execute(code, args, cb) -&gt; cb(err, result)<br>
- execute(code, cb) -&gt; cb(err, value returned)<br>
+ execute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -356,9 +356,9 @@
Execute script using eval(code): <br>
- safeExecute(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, args, cb) -&gt; cb(err, result)<br>
- safeExecute(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -400,9 +400,9 @@
<p>
- executeAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, args, cb) -&gt; cb(err, result)<br>
- executeAsync(code, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -414,9 +414,9 @@
Execute async script using eval(code): <br>
- safeExecuteAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, args, cb) -&gt; cb(err, result)<br>
- safeExecuteAsync(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -1124,23 +1124,23 @@
<p>
- text(element, cb) -&gt; (err, text)<br>
+ text(element, cb) -&gt; cb(err, text)<br>
element: specific element, 'body', or undefined<br>
</p>
<p>
- element.text(cb) -&gt; (err, text)<br>
+ element.text(cb) -&gt; cb(err, text)<br>
</p>
<p>
Check if text is present: <br>
- textPresent(searchText, element, cb) -&gt; (err, boolean)<br>
+ textPresent(searchText, element, cb) -&gt; cb(err, boolean)<br>
element: specific element, 'body', or undefined<br>
@@ -1150,7 +1150,7 @@
<p>
- element.textPresent(searchText, cb) -&gt; (err, boolean)<br>
+ element.textPresent(searchText, cb) -&gt; cb(err, boolean)<br>
<br>
View
@@ -342,9 +342,9 @@
<p>
- execute(code, args, cb) -&gt; cb(err, value returned)<br>
+ execute(code, args, cb) -&gt; cb(err, result)<br>
- execute(code, cb) -&gt; cb(err, value returned)<br>
+ execute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -356,9 +356,9 @@
Execute script using eval(code): <br>
- safeExecute(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, args, cb) -&gt; cb(err, result)<br>
- safeExecute(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecute(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -400,9 +400,9 @@
<p>
- executeAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, args, cb) -&gt; cb(err, result)<br>
- executeAsync(code, cb) -&gt; cb(err, value returned)<br>
+ executeAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -414,9 +414,9 @@
Execute async script using eval(code): <br>
- safeExecuteAsync(code, args, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, args, cb) -&gt; cb(err, result)<br>
- safeExecuteAsync(code, cb) -&gt; cb(err, value returned)<br>
+ safeExecuteAsync(code, cb) -&gt; cb(err, result)<br>
args: script argument array (optional)<br>
@@ -854,23 +854,23 @@
<p>
- text(element, cb) -&gt; (err, text)<br>
+ text(element, cb) -&gt; cb(err, text)<br>
element: specific element, 'body', or undefined<br>
</p>
<p>
- element.text(cb) -&gt; (err, text)<br>
+ element.text(cb) -&gt; cb(err, text)<br>
</p>
<p>
Check if text is present: <br>
- textPresent(searchText, element, cb) -&gt; (err, boolean)<br>
+ textPresent(searchText, element, cb) -&gt; cb(err, boolean)<br>
element: specific element, 'body', or undefined<br>
@@ -880,7 +880,7 @@
<p>
- element.textPresent(searchText, cb) -&gt; (err, boolean)<br>
+ element.textPresent(searchText, cb) -&gt; cb(err, boolean)<br>
<br>
View
@@ -40,7 +40,7 @@ element.prototype.click = function (cb) {
};
/**
- * element.text(cb) -> (err, text)
+ * element.text(cb) -> cb(err, text)
*
* @jsonWire GET /session/:sessionId/element/:id/text
* @docOrder 2
@@ -50,7 +50,7 @@ element.prototype.text = function (cb) {
};
/**
- * element.textPresent(searchText, cb) -> (err, boolean)
+ * element.textPresent(searchText, cb) -> cb(err, boolean)
*
* @jsonWire GET /session/:sessionId/element/:id/text
* @docOrder 4
View
@@ -619,8 +619,8 @@ webdriver.prototype.safeEval = function(code, cb) {
};
/**
- * execute(code, args, cb) -> cb(err, value returned)
- * execute(code, cb) -> cb(err, value returned)
+ * execute(code, args, cb) -> cb(err, result)
+ * execute(code, cb) -> cb(err, result)
* args: script argument array (optional)
*
* @jsonWire POST /session/:sessionId/execute
@@ -651,8 +651,8 @@ var safeExecuteJsScript = fs.readFileSync( __dirname + "/../browser-scripts/safe
/**
* Execute script using eval(code):
- * safeExecute(code, args, cb) -> cb(err, value returned)
- * safeExecute(code, cb) -> cb(err, value returned)
+ * safeExecute(code, args, cb) -> cb(err, result)
+ * safeExecute(code, cb) -> cb(err, result)
* args: script argument array (optional)
*
* @jsonWire POST /session/:sessionId/execute
@@ -679,8 +679,8 @@ webdriver.prototype.safeExecute = function(code,args,cb) {
}
/**
- * executeAsync(code, args, cb) -> cb(err, value returned)
- * executeAsync(code, cb) -> cb(err, value returned)
+ * executeAsync(code, args, cb) -> cb(err, result)
+ * executeAsync(code, cb) -> cb(err, result)
* args: script argument array (optional)
*
* @jsonWire POST /session/:sessionId/execute_async
@@ -710,8 +710,8 @@ var safeExecuteAsyncJsScript = fs.readFileSync( __dirname + "/../browser-scripts
/**
* Execute async script using eval(code):
- * safeExecuteAsync(code, args, cb) -> cb(err, value returned)
- * safeExecuteAsync(code, cb) -> cb(err, value returned)
+ * safeExecuteAsync(code, args, cb) -> cb(err, result)
+ * safeExecuteAsync(code, cb) -> cb(err, result)
* args: script argument array (optional)
*
* @jsonWire POST /session/:sessionId/execute_async
@@ -1379,7 +1379,7 @@ webdriver.prototype._rawText = function(element, cb) {
}
/**
- * text(element, cb) -> (err, text)
+ * text(element, cb) -> cb(err, text)
* element: specific element, 'body', or undefined
*
* @jsonWire GET /session/:sessionId/element/:id/text
@@ -1398,7 +1398,7 @@ webdriver.prototype.text = function(element, cb) {
/**
* Check if text is present:
- * textPresent(searchText, element, cb) -> (err, boolean)
+ * textPresent(searchText, element, cb) -> cb(err, boolean)
* element: specific element, 'body', or undefined
*
* @jsonWire GET /session/:sessionId/element/:id/text

0 comments on commit 6bbadcf

Please sign in to comment.