Changed JSDocs slightly.

unknown · unknown · commit 79ef613bbc49 · 2016-02-22T15:28:04.000-05:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -18,7 +18,7 @@ module.exports = function(grunt) {
     },
     jsdoc: {
       dist: {
-        src: ["lib/*.js", "tests/*.js"],
+        src: "lib/*.js",
         options: {
           destination: "target/html"
         }
diff --git a/lib/Api.js b/lib/Api.js
@@ -39,7 +39,17 @@ var checkVersion = require("./checkVersion");
  */
 var BINDING_VERSION = "0.8";
 
-// need to test with serviceURL
+/**
+ * @class
+ *
+ * Node.js Client Binding API; representation of a Api server.
+ * Call instance methods upon this object to communicate with particular
+ * Api server endpoints.
+ *
+ * @example var api = new API(userKey, serviceUrl);
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function Api(userKey, serviceURL) {
     /**
      * @type {string}
@@ -68,7 +78,8 @@ function Api(userKey, serviceURL) {
 };
 
 /**
- * Accepts a Rosette API endpoint name and forwards user parameters to the endpoint
+ * @type {string}
+ * @desc Accepts a Rosette API endpoint name and forwards user parameters to the endpoint
  * @param {string} endpoint - The Rosette API endpoint to be utilized
  */
 Api.prototype.rosette = function(endpoint, callback) {
diff --git a/lib/categories.js b/lib/categories.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function categories() {
 
 };
diff --git a/lib/checkVersion.js b/lib/checkVersion.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function checkVersion() {
 
 };
diff --git a/lib/entities.js b/lib/entities.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function entities() {
 
 };
diff --git a/lib/info.js b/lib/info.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function info() {
 
 };
diff --git a/lib/language.js b/lib/language.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function language() {
 
 };
diff --git a/lib/languageInfo.js b/lib/languageInfo.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function languageInfo() {
 
 };
diff --git a/lib/matchedName.js b/lib/matchedName.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function matchedName() {
 
 };
diff --git a/lib/morphology.js b/lib/morphology.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function morphology() {
 
 };
diff --git a/lib/parameters.js b/lib/parameters.js
@@ -17,6 +17,12 @@ var RosetteException = require("./rosetteExceptions");
 var RosetteConstants = require("./rosetteConstants");
 var fs = require("fs");
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function parameters() {
 
     // generic parameters
@@ -98,7 +104,7 @@ parameters.prototype.loadParams = function() {
 
 /**
  * Reads a file and sets the content, contentType, and unit parameters accordingly
- *@param {file} The file path from which the desired file will be loaded
+ *@param {file} filePath - The file path from which the desired file will be loaded
  */
 parameters.prototype.loadFile = function(filePath) {
     var str = fs.readFileSync(filePath, "base64");
diff --git a/lib/ping.js b/lib/ping.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function ping() {
 
 };
diff --git a/lib/relationships.js b/lib/relationships.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function relationships() {
 
 };
diff --git a/lib/sentences.js b/lib/sentences.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function sentences() {
 
 };
diff --git a/lib/sentiment.js b/lib/sentiment.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function sentiment() {
 
 };
diff --git a/lib/tokens.js b/lib/tokens.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function tokens() {
 
 };
diff --git a/lib/translatedName.js b/lib/translatedName.js
@@ -28,6 +28,12 @@ var RosetteException = require("./rosetteExceptions");
  */
 var BINDING_VERSION = "0.8";
 
+/**
+ * @class
+ *
+ * @copyright 2014-2015 Basis Technology Corporation.
+ * @license http://www.apache.org/licenses/LICENSE-2.0
+ */
 function nameTranslation() {
 
 };

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ module.exports = function(grunt) {`
`18`	`18`	`},`
`19`	`19`	`jsdoc: {`
`20`	`20`	`dist: {`
`21`		`- src: ["lib/.js", "tests/.js"],`
	`21`	`+ src: "lib/*.js",`
`22`	`22`	`options: {`
`23`	`23`	`destination: "target/html"`
`24`	`24`	`}`