Various small documentation fixes (playcanvas#1067)

Philippe Vaillancourt · willeastcott · commit 8b912188aa47 · 2018-01-02T13:24:49.000-08:00
* Fix small typo * Add @returns documentation for pc.Controller#isPressed * Remove duplicate [options.cache] param description from pc.Http methods * Add @returns documentation for pc.SoundInstance#stop * Make 'request' a property defined as a function once again
diff --git a/src/framework/components/rigid-body/system.js b/src/framework/components/rigid-body/system.js
@@ -19,7 +19,7 @@ pc.extend(pc, function () {
     /**
     * @name pc.RaycastResult
     * @class Object holding the result of a successful raycast hit
-    * @description Create a new RaycastResul
+    * @description Create a new RaycastResult
     * @param {pc.Entity} entity The entity that was hit
     * @param {pc.Vec3} point The point at which the ray hit the entity in world space
     * @param {pc.Vec3} normal The normal vector of the surface where the ray hit in world space.
diff --git a/src/input/controller.js b/src/input/controller.js
@@ -281,8 +281,9 @@ pc.extend(pc, function () {
     /**
      * @function
      * @name pc.Controller#isPressed
-     * @description Return true if the current action is enabled
+     * @description Returns true if the current action is enabled
      * @param {String} action The name of the action
+     * @returns {Boolean} True if the action is enabled
      */
     Controller.prototype.isPressed = function (actionName) {
         if(!this._actions[actionName]) {
diff --git a/src/net/http.js b/src/net/http.js
@@ -62,7 +62,6 @@ pc.extend(pc, function () {
          * @param {Document | Object} [options.postdata] Data to send in the body of the request.
          * Some content types are handled automatically, If postdata is an XML Document it is handled, if the Content-Type header is set to 'application/json' then
          * the postdata is JSON stringified, otherwise by default the data is sent as form-urlencoded
-         * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Function} callback The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type, text, Object, ArrayBuffer, XML) and err is the error code.
          * @example
          * pc.http.get("http://example.com/", function (err, response) {
@@ -88,7 +87,6 @@ pc.extend(pc, function () {
          * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Boolean} [options.withCredentials] Send cookies with this request (default: true)
          * @param {String} [options.responseType] Override the response type
-         * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Object} data Data to send in the body of the request.
          * Some content types are handled automatically, If postdata is an XML Document it is handled, if the Content-Type header is set to 'application/json' then
          * the postdata is JSON stringified, otherwise by default the data is sent as form-urlencoded
@@ -114,7 +112,6 @@ pc.extend(pc, function () {
          * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Boolean} [options.withCredentials] Send cookies with this request (default: true)
          * @param {String} [options.responseType] Override the response type
-         * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Document | Object} data Data to send in the body of the request.
          * Some content types are handled automatically, If postdata is an XML Document it is handled, if the Content-Type header is set to 'application/json' then
          * the postdata is JSON stringified, otherwise by default the data is sent as form-urlencoded
@@ -143,7 +140,6 @@ pc.extend(pc, function () {
          * @param {Document | Object} [options.postdata] Data to send in the body of the request.
          * Some content types are handled automatically, If postdata is an XML Document it is handled, if the Content-Type header is set to 'application/json' then
          * the postdata is JSON stringified, otherwise by default the data is sent as form-urlencoded
-         * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Function} callback The callback used when the response has returned. Passed (err, data) where data is the response (format depends on response type, text, Object, ArrayBuffer, XML) and err is the error code.
          */
         del: function (url, options, callback) {
@@ -169,7 +165,6 @@ pc.extend(pc, function () {
          * @param {Document|Object} [options.postdata] Data to send in the body of the request.
          * Some content types are handled automatically, If postdata is an XML Document it is handled, if the Content-Type header is set to 'application/json' then
          * the postdata is JSON stringified, otherwise by default the data is sent as form-urlencoded
-         * @param {Object} [options.cache] If false, then add a timestamp to the request to prevent caching
          * @param {Function} callback The callback used when the response has retured. Passed (err, data) where data is the response (format depends on response type, text, Object, ArrayBuffer, XML) and err is the error code.
          */
         request: function (method, url, options, callback) {
diff --git a/src/sound/instance.js b/src/sound/instance.js
@@ -278,6 +278,7 @@ pc.extend(pc, function () {
              * @function
              * @name pc.SoundInstance#stop
              * @description Stops playback of sound. Calling play() again will restart playback from the beginning of the sound.
+             * @returns {Boolean} Returns true if the sound was stopped.
              */
             stop: function () {
                 if (this._state === STATE_STOPPED || !this.source)
