Merge pull request #8126 from adobe/jbalsas/jsdoc_typos

redmunds · redmunds · commit c29e5b64d7a4 · 2014-06-14T12:11:43.000-07:00
Fix some jsdoc tags typos
diff --git a/src/extensibility/Package.js b/src/extensibility/Package.js
@@ -68,7 +68,7 @@ define(function (require, exports, module) {
     
     /**
      * @private
-     * @type{jQuery.Deferred.<NodeConnection>}
+     * @type {jQuery.Deferred.<NodeConnection>}
      * A deferred which is resolved with a NodeConnection or rejected if
      * we are unable to connect to Node.
      */
diff --git a/src/filesystem/FileSystem.js b/src/filesystem/FileSystem.js
@@ -221,16 +221,16 @@ define(function (require, exports, module) {
      * objects which contain a file entry, filter function, and an indication of
      * whether the watched root is inactive, starting up or fully active.
      * 
-     * @type{Object.<string, WatchedRoot>}
+     * @type {Object.<string, WatchedRoot>}
      */
     FileSystem.prototype._watchedRoots = null;
     
     /**
      * Finds a parent watched root for a given path, or returns null if a parent
      * watched root does not exist.
      * 
-     * @param{string} fullPath The child path for which a parent watched root is to be found
-     * @return{?{entry: FileSystemEntry, filter: function(string) boolean}} The parent
+     * @param {string} fullPath The child path for which a parent watched root is to be found
+     * @return {?{entry: FileSystemEntry, filter: function(string) boolean}} The parent
      *      watched root, if it exists, or null.
      */
     FileSystem.prototype._findWatchedRootForPath = function (fullPath) {
diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js
@@ -162,7 +162,7 @@ define(function (require, exports, module) {
     /**
      * @private
      * Encoded URL
-     * @ see getBaseUrl(), setBaseUrl()
+     * @see getBaseUrl(), setBaseUrl()
      */
     var _projectBaseUrl = "";
     
@@ -1756,7 +1756,7 @@ define(function (require, exports, module) {
      * Rename a file/folder. This will update the project tree data structures
      * and send notifications about the rename.
      *
-     * @prarm {string} oldName Old item name
+     * @param {string} oldName Old item name
      * @param {string} newName New item name
      * @param {boolean} isFolder True if item is a folder; False if it is a file.
      * @return {$.Promise} A promise object that will be resolved or rejected when
diff --git a/src/project/WorkingSetView.js b/src/project/WorkingSetView.js
@@ -221,7 +221,7 @@ define(function (require, exports, module) {
      * Starts the drag and drop working set view reorder.
      * @private
      * @param {!Event} event - jQuery event
-     * @paran {!HTMLLIElement} $listItem - jQuery element
+     * @param {!HTMLLIElement} $listItem - jQuery element
      * @param {?bool} fromClose - true if reorder was called from the close icon
      */
     function _reorderListItem(event, $listItem, fromClose) {
diff --git a/src/utils/NodeConnection.js b/src/utils/NodeConnection.js
@@ -123,7 +123,7 @@ define(function (require, exports, module) {
     }
     
     /**
-     * @type{Object}
+     * @type {Object}
      * Exposes the domains registered with the server. This object will
      * have a property for each registered domain. Each of those properties
      * will be an object containing properties for all the commands in that
@@ -138,51 +138,51 @@ define(function (require, exports, module) {
     
     /**
      * @private
-     * @type{Array.<string>}
+     * @type {Array.<string>}
      * List of module pathnames that should be re-registered if there is
      * a disconnection/connection (i.e. if the server died).
      */
     NodeConnection.prototype._registeredModules = null;
 
     /**
      * @private
-     * @type{WebSocket}
+     * @type {WebSocket}
      * The connection to the server
      */
     NodeConnection.prototype._ws = null;
     
     /**
      * @private
-     * @type{?number}
+     * @type {?number}
      * The port the WebSocket is currently connected to
      */
     NodeConnection.prototype._port = null;
     
     /**
      * @private
-     * @type{number}
+     * @type {number}
      * Unique ID for commands
      */
     NodeConnection.prototype._commandCount = 1;
     
     /**
      * @private
-     * @type{boolean}
+     * @type {boolean}
      * Whether to attempt reconnection if connection fails
      */
     NodeConnection.prototype._autoReconnect = false;
     
     /**
      * @private
-     * @type{Array.<jQuery.Deferred>}
+     * @type {Array.<jQuery.Deferred>}
      * List of deferred objects that should be resolved pending
      * a successful refresh of the API
      */
     NodeConnection.prototype._pendingInterfaceRefreshDeferreds = null;
     
     /**
      * @private
-     * @type{Array.<jQuery.Deferred>}
+     * @type {Array.<jQuery.Deferred>}
      * Array (indexed on command ID) of deferred objects that should be
      * resolved/rejected with the response of commands.
      */
@@ -328,7 +328,7 @@ define(function (require, exports, module) {
 
     /**
      * Determines whether the NodeConnection is currently connected
-     * @return{boolean} Whether the NodeConnection is connected.
+     * @return {boolean} Whether the NodeConnection is connected.
      */
     NodeConnection.prototype.connected = function () {
         return !!(this._ws && this._ws.readyState === WebSocket.OPEN);
