improvement in documentation of methods of oscillator node

Author: endurance21

lib/p5.sound.js

@@ -1,4 +1,4 @@
-/** [p5.sound]  Version: 0.3.12 - 2020-01-06 */ 
+/** [p5.sound]  Version: 0.3.12 - 2020-03-16 */ 
  /**
  *  <p>p5.sound extends p5 with <a href="http://caniuse.com/audio-api"
  *  target="_blank">Web Audio</a> functionality including audio input,
@@ -1577,6 +1577,14 @@ var __WEBPACK_AMD_DEFINE_RESULT__;
 
 
   p5.Oscillator.prototype.fade = p5.Oscillator.prototype.amp;
+  /**
+   * Returns the value of output gain 
+   *
+   *  @method  getAmp
+   *  @for p5.Oscillator
+   * 
+   * @return  {number} Amplitude value between 0.0 and 1.0
+   */
 
   p5.Oscillator.prototype.getAmp = function () {
     return this.output.gain.value;
@@ -1655,6 +1663,14 @@ var __WEBPACK_AMD_DEFINE_RESULT__;
       return this.oscillator.frequency;
     }
   };
+  /**
+  * Returns the value of frequency of oscillator 
+  *
+  *  @method  getFreq
+  *  @for p5.Oscillator
+  *  @returns {number} Frequency of oscillator in Hertz 
+  */
+
 
   p5.Oscillator.prototype.getFreq = function () {
     return this.oscillator.frequency.value;
@@ -1671,6 +1687,14 @@ var __WEBPACK_AMD_DEFINE_RESULT__;
   p5.Oscillator.prototype.setType = function (type) {
     this.oscillator.type = type;
   };
+  /**
+   *  Returns  current type of oscillator eg. 'sine', 'triangle', 'sawtooth' or 'square'.
+   *
+   *  @method  getType
+   *  @for p5.Oscillator
+   *  @returns {String} type of oscillator  eg . 'sine', 'triangle', 'sawtooth' or 'square'.
+   */
+
 
   p5.Oscillator.prototype.getType = function () {
     return this.oscillator.type;
@@ -1733,6 +1757,15 @@ var __WEBPACK_AMD_DEFINE_RESULT__;
     this.panPosition = pval;
     this.panner.pan(pval, tFromNow);
   };
+  /**
+   *  Returns the current value of panPosition , between Left (-1) and Right (1)
+   *
+   *  @method  getPan
+   *  @for p5.Oscillator
+   * 
+   *  @returns {number} panPosition of oscillator , between Left (-1) and Right (1)
+   */
+
 
   p5.Oscillator.prototype.getPan = function () {
     return this.panPosition;

lib/p5.sound.js.map

@@ -218,6 +218,8 @@ define(function (require) {
    *
    *  @method  getAmp
    *  @for p5.Oscillator
+   * 
+   * @return  {number} Amplitude value between 0.0 and 1.0
    */ 
   p5.Oscillator.prototype.getAmp = function() {
     return this.output.gain.value;
@@ -305,6 +307,7 @@ define(function (require) {
    *
    *  @method  getFreq
    *  @for p5.Oscillator
+   *  @returns {number} Frequency of oscillator in Hertz 
    */ 
 
   p5.Oscillator.prototype.getFreq = function() {
@@ -326,7 +329,7 @@ define(function (require) {
    *
    *  @method  getType
    *  @for p5.Oscillator
-   *  @param {String} type 'sine', 'triangle', 'sawtooth' or 'square'.
+   *  @returns {String} type of oscillator  eg . 'sine', 'triangle', 'sawtooth' or 'square'.
    */
 
   p5.Oscillator.prototype.getType = function() {
@@ -392,6 +395,8 @@ define(function (require) {
    *
    *  @method  getPan
    *  @for p5.Oscillator
+   * 
+   *  @returns {number} panPosition of oscillator , between Left (-1) and Right (1)
    */
 
   p5.Oscillator.prototype.getPan = function() {