📝 add JSDoc for methods

Author: Ammar Dodin

personality-insights/v2.ts

@@ -22,21 +22,35 @@ import { BaseService } from '../lib/base_service';
 
 class PersonalityInsightsV2 extends BaseService {
   static URL: string = 'https://gateway.watsonplatform.net/personality-insights/api';
-  
+
+  /**
+   * Construct a PersonalityInsightsV2 object.
+   *
+   * @param {Object} options - Options for the service.
+   * @param {string} options.version_date - The API version date to use with the service, in "YYYY-MM-DD" format. Whenever the API is changed in a backwards incompatible way, a new minor version of the API is released. The service uses the API version for the date you specify, or the most recent version before that date. Note that you should not programmatically specify the current date at runtime, in case the API has been updated since your application's release. Instead, specify a version date that is compatible with your application, and don't change it until your application is ready for a later version.
+   * @param {string} [options.url] - The base url to use when contacting the service (e.g. 'https://gateway.watsonplatform.net/personality-insights/api'). The base url may differ between Bluemix regions.
+   * @param {string} [options.username] - The username used to authenticate with the service. Username and password credentials are only required to run your application locally or outside of Bluemix. When running on Bluemix, the credentials will be automatically loaded from the `VCAP_SERVICES` environment variable.
+   * @param {string} [options.password] - The password used to authenticate with the service. Username and password credentials are only required to run your application locally or outside of Bluemix. When running on Bluemix, the credentials will be automatically loaded from the `VCAP_SERVICES` environment variable.
+   * @param {boolean} [options.use_unauthenticated] - Set to `true` to avoid including an authorization header. This option may be useful for requests that are proxied.
+   * @param {Object} [options.headers] - Default headers that shall be included with every request to the service.
+   * @param {boolean} [options.headers.X-Watson-Learning-Opt-Out] - Set to `true` to opt-out of data collection. By default, all IBM Watson services log requests and their results. Logging is done only to improve the services for future users. The logged data is not shared or made public. If you are concerned with protecting the privacy of users' personal information or otherwise do not want your requests to be logged, you can opt out of logging.
+   * @constructor
+   * @returns {PersonalityInsightsV2}
+   * @throws {Error}
+   */
   constructor(options: PersonalityInsightsV2.Options) {
     super(options);
   }
 
   /**
-   * @param params {Object} The parameters to call the service
-   *   The accepted parameters are:
-   *     - text: The text to analyze.
-   *     - contentItems: A JSON input (if 'text' not provided).
-   *     - include_raw: include raw results
-   *     - accept_language : The language expected for the output.
-   *     - language: The language of the input.
-   *
+   * @param {Object} params - The parameters to call the service
+   * @param {string} text - The text to analyze.
+   * @param {Object} contentItems - A JSON input (if 'text' is not provided).
+   * @param {boolean} include_raw - include raw results
+   * @param {boolean} accept_language - The language expected for the output.
+   * @param {string} language - The language of the input.
    * @param callback The callback.
+   * @returns {ReadableStream|void}
    */
   profile(
     params: PersonalityInsightsV2.ProfileParams,