improved docs

webdriverio · Jun 18, 2014 · 0f715dd · 0f715dd
1 parent 76b4cfa
commit 0f715dd
Show file tree

Hide file tree

Showing 163 changed files with 278 additions and 89 deletions.
diff --git a/lib/commands/addValue.js b/lib/commands/addValue.js
@@ -9,9 +9,7 @@
  * @param {String=} values     Input element
  *
  * @uses protocol/elements, protocol/elemendIdValue
- *
- * @test addValue.js test/spec/desktop/addValue/index.js
- * @test index.html test/spec/desktop/addValue/index.html
+ * @type action
  *
  */
 

diff --git a/lib/commands/buttonClick.js b/lib/commands/buttonClick.js
@@ -3,6 +3,7 @@
  * Click on a button using a css selector.
  *
  * @param {String} selector button element
+ * @type action
  * @deprecated still included for backward compatibility (see click)
  *
  */

diff --git a/lib/commands/call.js b/lib/commands/call.js
@@ -2,6 +2,9 @@
  *
  * call own function wihtin the chain
  *
+ * @param {Function} callback  function to be called
+ * @type utility
+ *
  * ### Example usage
  *
  *     it('some title', function(done) {

diff --git a/lib/commands/chooseFile.js b/lib/commands/chooseFile.js
@@ -7,7 +7,8 @@
  * @param {String} selector   input element
  * @param {String} localPath  local path to file to be uploaded
  *
- * @uses actions/uploadFile, actions/addValue
+ * @uses action/uploadFile, action/addValue
+ * @type utility
  *
  */
 
@@ -29,7 +30,7 @@ module.exports = function chooseFile(selector, localPath) {
         return callback(new ErrorHandler.CommandError('number or type of arguments don\'t agree with chooseFile command'));
     }
 
-    /**
+    /*!
      * mobile check
      */
     if(!this.isMobile) {

diff --git a/lib/commands/clearElement.js b/lib/commands/clearElement.js
@@ -4,6 +4,7 @@
  *
  * @param {String} selector input element
  * @uses protocol/elements, protocol/elementIdClear
+ * @type action
  *
  */
 

diff --git a/lib/commands/click.js b/lib/commands/click.js
@@ -4,6 +4,7 @@
  *
  * @param {String} selector element to click on. If it matches with more than on DOM-element it automatically clicks on the first element
  * @uses protocol/element, protocol/elementIdClick, protocol/touchClick
+ * @type action
  *
  */
 

diff --git a/lib/commands/close.js b/lib/commands/close.js
@@ -4,6 +4,7 @@
  *
  * @param {String=} windowHandle new window to focus on
  * @uses protocol/window, window/switchTab
+ * @type window
  *
  */
 

diff --git a/lib/commands/deleteCookie.js b/lib/commands/deleteCookie.js
@@ -4,6 +4,7 @@
  *
  * @param {String} name name of cookie
  * @uses protocol/cookie
+ * @type cookie
  *
  */
 

diff --git a/lib/commands/doubleClick.js b/lib/commands/doubleClick.js
@@ -3,7 +3,8 @@
  * Double-click on an element based on a css selector.
  *
  * @param {String} selector element to double click on. If it matches with more than on DOM-element it automatically clicks on the first element
- * @uses protocol/element, protocol/moveTo, protocol/doDoubleClick
+ * @uses protocol/element, protocol/moveTo, protocol/doDoubleClick, protocol/touchDoubleClick
+ * @type action
  *
  */
 

diff --git a/lib/commands/dragAndDrop.js b/lib/commands/dragAndDrop.js
@@ -5,7 +5,8 @@
  * @param {String} cssSourceElem      source css selector
  * @param {String} cssDestinationElem destination css selector
  *
- * @uses actions/moveToObject, protocol/buttonDown, protocol/buttonUp, properties/getLocation, protocol/touchDown, protocol/touchMove, protocol/touchUp
+ * @uses action/moveToObject, protocol/buttonDown, protocol/buttonUp, properties/getLocation, protocol/touchDown, protocol/touchMove, protocol/touchUp
+ * @type action
  *
  */
 

diff --git a/lib/commands/end.js b/lib/commands/end.js
@@ -3,6 +3,7 @@
  * End the session and close browser.
  *
  * @uses protocol/session
+ * @type utility
  */
 
 module.exports = function end () {

diff --git a/lib/commands/endAll.js b/lib/commands/endAll.js
@@ -3,6 +3,7 @@
  * End all sessions and close browser.
  *
  * @uses protocol/sessions, protocol/session
+ * @type utility
  *
  */
 

diff --git a/lib/commands/flick.js b/lib/commands/flick.js
@@ -15,6 +15,7 @@
  * @param {Number=} yoffset    y offset of flick gesture (in pixels or relative units)
  *
  * @uses protocol/element, protocol/touchFlick
+ * @type mobile
  *
  */
 
@@ -31,7 +32,7 @@ module.exports = function flick (selector, xoffset, yoffset, speed) {
     var self = this,
         response = {};
 
-    /**
+    /*!
      * mobile check
      */
     if(!this.isMobile) {
@@ -40,7 +41,7 @@ module.exports = function flick (selector, xoffset, yoffset, speed) {
 
     if(arguments.length === 3 && typeof selector === 'number' && typeof xoffset === 'number') {
 
-        /**
+        /*!
          * you don't care where the flick starts on the screen
          */
 
@@ -63,7 +64,7 @@ module.exports = function flick (selector, xoffset, yoffset, speed) {
 
     } else {
 
-        /**
+        /*!
          * command starts at a particular screen location
          */
 

diff --git a/lib/commands/flickDown.js b/lib/commands/flickDown.js
@@ -6,6 +6,7 @@
  * @param {Number} duration   time (in seconds) to spend performing the drag
  *
  * @uses mobile/flick
+ * @type mobile
  *
  */
 
@@ -23,7 +24,7 @@ module.exports = function flickDown(selector, duration) {
         selector = null;
     }
 
-    /**
+    /*!
      * set default duration if not set
      */
     if(typeof duration !== 'number') {

diff --git a/lib/commands/flickLeft.js b/lib/commands/flickLeft.js
@@ -5,7 +5,8 @@
  * @param {String} selector   element to drag on
  * @param {Number} duration   time (in seconds) to spend performing the drag
  *
- * @uses mobile/swipe
+ * @uses mobile/flick
+ * @type mobile
  *
  */
 
@@ -23,7 +24,7 @@ module.exports = function flickLeft (selector, duration) {
         selector = null;
     }
 
-    /**
+    /*!
      * set default duration if not set
      */
     if(typeof duration !== 'number') {

diff --git a/lib/commands/flickRight.js b/lib/commands/flickRight.js
@@ -5,7 +5,8 @@
  * @param {String} selector   element to drag on
  * @param {Number} duration   time (in seconds) to spend performing the drag
  *
- * @uses mobile/swipe
+ * @uses mobile/flick
+ * @type mobile
  *
  */
 
@@ -23,7 +24,7 @@ module.exports = function flickRight (selector, duration) {
         selector = null;
     }
 
-    /**
+    /*!
      * set default duration if not set
      */
     if(typeof duration !== 'number') {

diff --git a/lib/commands/flickUp.js b/lib/commands/flickUp.js
@@ -6,6 +6,7 @@
  * @param {Number} duration   time (in seconds) to spend performing the drag
  *
  * @uses mobile/flick
+ * @type mobile
  *
  */
 
@@ -23,7 +24,7 @@ module.exports = function flickUp(selector, duration) {
         selector = null;
     }
 
-    /**
+    /*!
      * set default duration if not set
      */
     if(typeof duration !== 'number') {

diff --git a/lib/commands/getAttribute.js b/lib/commands/getAttribute.js
@@ -9,6 +9,7 @@
  * @returns {String|String[]|null} The value of the attribute(s), or null if it is not set on the element.
  *
  * @uses protocol/elements, protocol/elementIdAttribute
+ * @type property
  *
  */
 

diff --git a/lib/commands/getCookie.js b/lib/commands/getCookie.js
@@ -7,6 +7,7 @@
  * @returns {Object|null} requested cookie if existing
  *
  * @uses protocol/cookie
+ * @type cookie
  *
  */
 
@@ -51,7 +52,7 @@ module.exports = function getCookie (name) {
             cookie = null;
         }
 
-        /**
+        /*!
          * return null if a specific cookie was selected, otherwise
          * return [] because user expects an array of cookies
          */

diff --git a/lib/commands/getCssProperty.js b/lib/commands/getCssProperty.js
@@ -49,6 +49,7 @@
  * @param {String} cssProperty css property name
  *
  * @uses protocol/elements, protocol/elementIdCssProperty
+ * @type property
  *
  */
 

diff --git a/lib/commands/getCurrentTabId.js b/lib/commands/getCurrentTabId.js
@@ -4,6 +4,7 @@
  *
  * @returns {String} the window handle URL of the current focused window
  * @uses protocol/windowHandle
+ * @type window
  *
  */
 

diff --git a/lib/commands/getElementCssProperty.js b/lib/commands/getElementCssProperty.js
@@ -1,10 +1,9 @@
 /**
  *
  * @deprecated this command is obsolete since the selector API was introduced. Its only purpose is for backwards compability.
- * @use getCssProperty
- * @todo should be removed some day
  *
- * @uses properties/getCssProperty
+ * @uses property/getCssProperty
+ * @type property
  *
  */
 

diff --git a/lib/commands/getElementSize.js b/lib/commands/getElementSize.js
@@ -2,10 +2,11 @@
  *
  * Get the width and height for an DOM-element based on the css selector.
  *
- * @param {String} selector element with requested size
- * @returns {Object}        requested element size (`{width:number, height:number}`)
+ * @param   {String} selector element with requested size
+ * @returns {Object}          requested element size (`{width:number, height:number}`)
  *
  * @uses protocol/elements, protocol/elementIdSize
+ * @type property
  *
  */
 

diff --git a/lib/commands/getGeoLocation.js b/lib/commands/getGeoLocation.js
@@ -4,6 +4,7 @@
  *
  * @returns {Object} the current geo location (`{latitude: number, longitude: number, altitude: number}`)
  * @uses protocol/location
+ * @type mobile
  *
  */
 

diff --git a/lib/commands/getHTML.js b/lib/commands/getHTML.js
@@ -6,6 +6,7 @@
  * @param {Boolean} includeSelectorTag if true it includes the tag of selector element
  *
  * @uses protocol/execute
+ * @type property
  *
  */
 

diff --git a/lib/commands/getLocation.js b/lib/commands/getLocation.js
@@ -7,6 +7,7 @@
  * @returns {Object|Object[]}  The X and Y coordinates for the element on the page (`{x:number, y:number}`)
  *
  * @uses protocol/elements, protocol/elementIdLocation
+ * @type property
  *
  */
 

diff --git a/lib/commands/getLocationInView.js b/lib/commands/getLocationInView.js
@@ -6,6 +6,7 @@
  * @returns {Object|Object[]}  The X and Y coordinates for the element on the page (`{x:number, y:number}`)
  *
  * @uses protocol/elements, protocol/elementIdLocationInView
+ * @type property
  *
  */
 

diff --git a/lib/commands/getOrientation.js b/lib/commands/getOrientation.js
@@ -4,6 +4,7 @@
  *
  * @returns {String} device orientation (`{landscape|portrait}`)
  * @uses protocol/orientation
+ * @type mobile
  *
  */
 

diff --git a/lib/commands/getSource.js b/lib/commands/getSource.js
@@ -4,6 +4,7 @@
  *
  * @returns {String} source code of current website
  * @uses protocol/source
+ * @type property
  *
  */
 

diff --git a/lib/commands/getTabIds.js b/lib/commands/getTabIds.js
@@ -4,6 +4,7 @@
  *
  * @returns {String[]} a list of window handles
  * @uses protocol/windowHandles
+ * @type window
  *
  */
 

diff --git a/lib/commands/getTagName.js b/lib/commands/getTagName.js
@@ -2,10 +2,11 @@
  *
  * Get tag name of a DOM-element found by the css selector.
  *
- * @param {String} selector   element with requested tag name
- * @returns {String|String[]} the element's tag name, as a lowercase string
+ * @param   {String}           selector   element with requested tag name
+ * @returns {String|String[]}             the element's tag name, as a lowercase string
  *
  * @uses protocol/elements, protocol/elementIdName
+ * @type property
  *
  */
 

diff --git a/lib/commands/getText.js b/lib/commands/getText.js
@@ -2,10 +2,11 @@
  *
  * Get the text content from a DOM-element found by the css selector.
  *
- * @param {String} selector   element with requested text
- * @returns {String|String[]} content of selected element (all HTML tags are removed)
+ * @param   {String}           selector   element with requested text
+ * @returns {String|String[]}             content of selected element (all HTML tags are removed)
  *
  * @uses protocol/elements, protocol/elementIdText
+ * @type property
  *
  */
 

diff --git a/lib/commands/getTitle.js b/lib/commands/getTitle.js
@@ -4,6 +4,7 @@
  *
  * @returns {String} current page title
  * @uses protocol/title
+ * @type property
  *
  */
 

diff --git a/lib/commands/getValue.js b/lib/commands/getValue.js
@@ -2,10 +2,11 @@
  *
  * Get the value of a `<textarea>` or text `<input>` found by css selector.
  *
- * @param {String} selector input or textarea element
- * @returns {String}        requested input value
+ * @param   {String} selector input or textarea element
+ * @returns {String}          requested input value
  *
  * @uses protocol/elements, protocol/elementIdAttribute
+ * @type property
  *
  */