Merge pull request #60 from anton-rudeshko/minors

A bunch of minor fixes

Added IntelliJ IDEA workspace to .gitignore
Fixed mixed tabs and spaces (replaced tabs with spaces)
Fixed typo
Fixed inappropriate JSDoc params
Added missing semicolons and proper indent

Author: lucasvo

.gitignore

@@ -12,4 +12,7 @@ logs
 results
 
 node_modules
-npm-debug.log
+npm-debug.log
+
+.idea
+*.iml

lib/jira.js

@@ -49,7 +49,7 @@
 // *  `Jira API Version<string>`: Known to work with `2` and `2.0.alpha1`
 // *  `verbose<bool>`: Log some info to the console, usually for debugging
 // *  `strictSSL<bool>`: Set to false if you have self-signed certs or something non-trustworthy
-// * `oauth`: A disctionary of `consumer_key`, `consumer_secret`, `access_token` and `access_token_secret` to be used for OAuth authentication.
+// * `oauth`: A dictionary of `consumer_key`, `consumer_secret`, `access_token` and `access_token_secret` to be used for OAuth authentication.
 //
 // ## Implemented APIs ##
 //
@@ -249,7 +249,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     // *  count: count of unresolved issues for requested version
     //
     // [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id288524)
-
     this.getUnresolvedIssueCount = function(version, callback) {
         var options = {
             rejectUnauthorized: this.strictSSL,
@@ -291,7 +290,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     // *  project: the json object representing the entire project
     //
     // [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id289232)
-
     this.getProject = function(project, callback) {
 
         var options = {
@@ -391,7 +389,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     /**
      * Returns a list of sprints belonging to a Rapid View.
      *
-     * @param rapidView ID
+     * @param rapidViewId
      * @param callback
      */
     this.getLastSprintForRapidView = function(rapidViewId, callback) {
@@ -443,8 +441,8 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     /**
      * Returns sprint and issues information
      *
-     * @param rapidView ID
-     * @param sprint ID
+     * @param rapidViewId
+     * @param sprintId
      * @param callback
      */
     this.getSprintIssues = function getSprintIssues(rapidViewId, sprintId, callback) {
@@ -565,8 +563,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
      * }
      *
      * @param link
-     * @param errorCallback
-     * @param successCallback
+     * @param callback
      */
     this.issueLink = function(link, callback) {
 
@@ -611,7 +608,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     // *  versions: array of the versions for a product
     //
     // [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id289653)
-
     this.getVersions = function(project, callback) {
 
         var options = {
@@ -784,7 +780,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     // *  issues: array of issues for the user
     //
     // [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id333082)
-    //
     this.searchJira = function(searchString, optional, callback) {
         // backwards compatibility
         optional = optional || {};
@@ -949,17 +944,18 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
         });
     };
-// ## Delete issue to Jira ##
-// ### Takes ###
-//
-// *  issueId: the Id of the issue to delete
-// *  callback: for when it's done
-//
-// ### Returns ###
-// *  error string
-// *  success object
-//
-// [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id290791)
+
+    // ## Delete issue to Jira ##
+    // ### Takes ###
+    //
+    // *  issueId: the Id of the issue to delete
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  success object
+    //
+    // [Jira Doc](http://docs.atlassian.com/jira/REST/latest/#id290791)
     this.deleteIssue = function(issueNum, callback) {
         var options = {
             rejectUnauthorized: this.strictSSL,
@@ -985,6 +981,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
         });
     };
+
     // ## Update issue in Jira ##
     // ### Takes ###
     //
@@ -1264,6 +1261,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
         });
     };
+
     // ## Transition issue in Jira ##
     // ### Takes ###
     //
@@ -1354,6 +1352,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
         });
     };
+
     // ## Add a comment to an issue ##
     // ### Takes ###
     // *  issueId: Issue to add a comment to
@@ -1394,6 +1393,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
             }
         });
     };
+
     // ## Add a worklog to a project ##
     // ### Takes ###
     // *  issueId: Issue to add a worklog to
@@ -1434,8 +1434,8 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
      */
     this.addWorklog = function(issueId, worklog, newEstimate, callback) {
         if(typeof callback == 'undefined') {
-          callback = newEstimate
-          newEstimate = false
+            callback = newEstimate;
+            newEstimate = false;
         }
         var options = {
             rejectUnauthorized: this.strictSSL,
@@ -1470,6 +1470,7 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
 
         });
     };
+
     // ## List all Issue Types ##
     // ### Takes ###
     //
@@ -1690,7 +1691,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
         });
     };
 
-
     // ## Describe the currently authenticated user ##
     // ### Takes ###
     //
@@ -1715,7 +1715,6 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
      *   }
      * }
      */
-
     this.getCurrentUser = function(callback) {
         var options = {
             rejectUnauthorized: this.strictSSL,
@@ -1742,94 +1741,94 @@ var JiraApi = exports.JiraApi = function(protocol, host, port, username, passwor
     };
 
     // ## Retrieve the backlog of a certain Rapid View ##
-	// ### Takes ###
-	// *  rapidViewId: rapid view id
-	// *  callback: for when it's done
-	//
-	// ### Returns ###
-	// *  error string
-	// *  backlog object
-	/*
-	 * Backlog item is in the format:
-	 *  {
-	 *      "sprintMarkersMigrated": true,
-	 *      "issues": [
-	 *          {
-	 *              "id": 67890,
-	 *              "key": "KEY-1234",
-	 *              "summary": "Issue Summary",
-	 *              ...
-	 *          }
-	 *      ],
-	 *      "rankCustomFieldId": 12345,
-	 *      "sprints": [
-	 *          {
-	 *              "id": 123,
-	 *              "name": "Sprint Name",
-	 *              "state": "FUTURE",
-	 *              ...
-	 *          }
-	 *      ],
-	 *      "supportsPages": true,
-	 *      "projects": [
-	 *          {
-	 *              "id": 567,
-	 *              "key": "KEY",
-	 *              "name": "Project Name"
-	 *          }
-	 *      ],
-	 *      "epicData": {
-	 *          "epics": [
-	 *              {
-	 *                  "id": 9876,
-	 *                  "key": "KEY-4554",
-	 *                  "typeName": "Epic",
-	 *                  ...
-	 *              }
-	 *          ],
-	 *          "canEditEpics": true,
-	 *          "supportsPages": true
-	 *      },
-	 *      "canManageSprints": true,
-	 *      "maxIssuesExceeded": false,
-	 *      "queryResultLimit": 2147483647,
-	 *      "versionData": {
-	 *          "versionsPerProject": {
-	 *              "567": [
-	 *                  {
-	 *                      "id": 8282,
-	 *                      "name": "Version Name",
-	 *                      ...
-	 *                  }
-	 *              ]
-	 *          },
-	 *          "canCreateVersion": true
-	 *      }
-	 *  }
-	 */
-	this.getBacklogForRapidView = function(rapidViewId, callback) {
-		var options = {
-			rejectUnauthorized: this.strictSSL,
-			uri: this.makeUri('/xboard/plan/backlog/data?rapidViewId=' + rapidViewId, 'rest/greenhopper/'),
-			method: 'GET',
-			json: true
-		};
-
-		this.doRequest(options, function(error, response) {
-			if (error) {
-				callback(error, null);
-
-				return;
-			}
-
-			if (response.statusCode === 200) {
-				callback(null, response.body);
-
-				return;
-			}
-
-			callback(response.statusCode + ': Error while retrieving backlog');
-		});
-	};
+    // ### Takes ###
+    // *  rapidViewId: rapid view id
+    // *  callback: for when it's done
+    //
+    // ### Returns ###
+    // *  error string
+    // *  backlog object
+    /*
+     * Backlog item is in the format:
+     *  {
+     *      "sprintMarkersMigrated": true,
+     *      "issues": [
+     *          {
+     *              "id": 67890,
+     *              "key": "KEY-1234",
+     *              "summary": "Issue Summary",
+     *              ...
+     *          }
+     *      ],
+     *      "rankCustomFieldId": 12345,
+     *      "sprints": [
+     *          {
+     *              "id": 123,
+     *              "name": "Sprint Name",
+     *              "state": "FUTURE",
+     *              ...
+     *          }
+     *      ],
+     *      "supportsPages": true,
+     *      "projects": [
+     *          {
+     *              "id": 567,
+     *              "key": "KEY",
+     *              "name": "Project Name"
+     *          }
+     *      ],
+     *      "epicData": {
+     *          "epics": [
+     *              {
+     *                  "id": 9876,
+     *                  "key": "KEY-4554",
+     *                  "typeName": "Epic",
+     *                  ...
+     *              }
+     *          ],
+     *          "canEditEpics": true,
+     *          "supportsPages": true
+     *      },
+     *      "canManageSprints": true,
+     *      "maxIssuesExceeded": false,
+     *      "queryResultLimit": 2147483647,
+     *      "versionData": {
+     *          "versionsPerProject": {
+     *              "567": [
+     *                  {
+     *                      "id": 8282,
+     *                      "name": "Version Name",
+     *                      ...
+     *                  }
+     *              ]
+     *          },
+     *          "canCreateVersion": true
+     *      }
+     *  }
+     */
+    this.getBacklogForRapidView = function(rapidViewId, callback) {
+        var options = {
+            rejectUnauthorized: this.strictSSL,
+            uri: this.makeUri('/xboard/plan/backlog/data?rapidViewId=' + rapidViewId, 'rest/greenhopper/'),
+            method: 'GET',
+            json: true
+        };
+
+        this.doRequest(options, function(error, response) {
+            if (error) {
+                callback(error, null);
+
+                return;
+            }
+
+            if (response.statusCode === 200) {
+                callback(null, response.body);
+
+                return;
+            }
+
+            callback(response.statusCode + ': Error while retrieving backlog');
+        });
+    };
 
 }).call(JiraApi.prototype);