yuidoc fixes (#199)

* yuidoc @type fixes

* more @type fixes

* docs: AudioIn.start parameters are optional

* docs: specify correct @Class for helpers

* more yuidoc fixes

* docs, use '...' to specify varargs

Author: Spongman

src/audioin.js

@@ -91,9 +91,9 @@ define(function (require) {
    *  the browser won't provide mic access.
    *
    *  @method start
-   *  @param {Function} successCallback Name of a function to call on
+   *  @param {Function} [successCallback] Name of a function to call on
    *                                    success.
-   *  @param {Function} errorCallback Name of a function to call if
+   *  @param {Function} [errorCallback] Name of a function to call if
    *                                    there was an error. For example,
    *                                    some browsers do not support
    *                                    getUserMedia.

src/compressor.js

@@ -64,16 +64,10 @@ define(function (require) {
   };
 
 
-
   /**
-   * Setter and Getter methdds 
-   * @method  {attack} set attack w/ time ramp or get current attack
-   * @method  {knee} set knee w/ time ramp or get current knee
-   * @method {ratio} set ratio w/ time ramp or get current ratio
-   * @method {threshold} set threshold w/ time ramp or get current threshold
-   * @method {release} set release w/ time ramp or get current release
+   * set attack w/ time ramp or get current attack
+   * @method attack
    */
-
   p5.Compressor.prototype.attack = function (attack, time){
     var t = time || 0;
     if (typeof attack == 'number'){
@@ -87,6 +81,10 @@ define(function (require) {
   };
 
 
+ /**
+   * set knee w/ time ramp or get current knee
+   * @method knee
+   */
   p5.Compressor.prototype.knee = function (knee, time){
     var t = time || 0;
     if (typeof knee == 'number'){
@@ -100,6 +98,10 @@ define(function (require) {
   };
 
 
+  /**
+   * set ratio w/ time ramp or get current ratio
+   * @method ratio
+   */
   p5.Compressor.prototype.ratio = function (ratio, time){
     var t = time || 0;
     if (typeof ratio == 'number'){
@@ -113,6 +115,10 @@ define(function (require) {
   };
 
 
+  /**
+   * set threshold w/ time ramp or get current threshold
+   * @method threshold
+   */
   p5.Compressor.prototype.threshold = function (threshold, time){
     var t = time || 0;
     if (typeof threshold == 'number'){
@@ -126,6 +132,10 @@ define(function (require) {
   };
 
 
+  /**
+   * set release w/ time ramp or get current release
+   * @method release
+   */
   p5.Compressor.prototype.release = function (release, time){
     var t = time || 0;
     if (typeof release == 'number'){

src/delay.js

@@ -67,17 +67,15 @@ define(function (require) {
      *  <a href="http://www.w3.org/TR/webaudio/#DelayNode">
      *  Web Audio Delay Nodes</a>, one for each stereo channel.
      *
-     *  @property leftDelay
-     *  @type {Object}  Web Audio Delay Node
+     *  @property leftDelay {Object}  Web Audio Delay Node
      */
     this.leftDelay = this.ac.createDelay();
     /**
      *  The p5.Delay is built with two
      *  <a href="http://www.w3.org/TR/webaudio/#DelayNode">
      *  Web Audio Delay Nodes</a>, one for each stereo channel.
      *
-     *  @property rightDelay
-     *  @type {Object}  Web Audio Delay Node
+     *  @property rightDelay {Object}  Web Audio Delay Node
      */
     this.rightDelay = this.ac.createDelay();
 

src/distortion.js

@@ -59,8 +59,7 @@ define(function (require) {
      *  <a href="http://www.w3.org/TR/webaudio/#WaveShaperNode">
      *  Web Audio WaveShaper Node</a>.
      *
-     *  @property WaveShaperNode
-     *  @type {Object}  AudioNode
+     *  @property WaveShaperNode {Object}  AudioNode
      */
     this.waveShaperNode = this.ac.createWaveShaper();
 
@@ -87,7 +86,6 @@ define(function (require) {
    * @param {Number} [amount=0.25] Unbounded distortion amount.
    *                                Normal values range from 0-1.
    * @param {String} [oversample='none'] 'none', '2x', or '4x'.
-   * @param {String}
    */
   p5.Distortion.prototype.set = function(amount, oversample) {
     if (amount) {

src/effect.js

@@ -23,17 +23,15 @@ define(function (require) {
 		/**
 		 *	The p5.Effect class is built
 		 * 	using Tone.js CrossFade
-		 *	@property _drywet
-		 *	@type {Object} ToneJS node
+		 *	@property _drywet {Object} ToneJS node
 		 */
 		this._drywet = new CrossFade(1);
 
 		/**
 		 *	In classes that extend
 		 *	p5.Effect, connect effect nodes
 		 *	to the wet parameter
-		 *	@property wet
-		 *	@type {Object} Web Audio Gain Node
+		 *	@property wet {Object} Web Audio Gain Node
 		 */
 		this.wet = this.ac.createGain();
 
@@ -126,7 +124,7 @@ define(function (require) {
 	 *	May be used with open-ended number of arguments
 	 *
 	 *	@method chain 
-     *  @param {Object} arguments p5.Effect objects	
+     *  @param {Object} [...effects] p5.Effect objects	
 	 */		
 	p5.Effect.prototype.chain = function(){
 		if (arguments.length>0){

src/env.js

@@ -368,7 +368,7 @@ define(function (require) {
    *  control all of them.
    *
    *  @method  setInput
-   *  @param  {Object} unit         A p5.sound object or
+   *  @param  {Object} [...inputs]         A p5.sound object or
    *                                Web Audio Param.
    */
   p5.Env.prototype.setInput = function() {

src/filter.js

@@ -22,7 +22,7 @@ define(function (require) {
    *
    *  @class p5.Filter
    *  @constructor
-   *  @param {[String]} type 'lowpass' (default), 'highpass', 'bandpass'
+   *  @param {String} [type] 'lowpass' (default), 'highpass', 'bandpass'
    *  @return {Object} p5.Filter
    *  @example
    *  <div><code>
@@ -86,8 +86,7 @@ define(function (require) {
       *  <a href="http://www.w3.org/TR/webaudio/#BiquadFilterNode">
       *  Web Audio BiquadFilter Node</a>.
       *
-      *  @property biquadFilter
-      *  @type {Object}  Web Audio Delay Node
+      *  @property biquadFilter {Object}  Web Audio Delay Node
 	  */
 
     this.biquad = this.ac.createBiquadFilter();
@@ -109,8 +108,8 @@ define(function (require) {
    *
    *  @method  process
    *  @param  {Object} Signal  An object that outputs audio
-   *  @param {[Number]} freq Frequency in Hz, from 10 to 22050
-   *  @param {[Number]} res Resonance/Width of the filter frequency
+   *  @param {Number} [freq] Frequency in Hz, from 10 to 22050
+   *  @param {Number} [res] Resonance/Width of the filter frequency
    *                        from 0.001 to 1000
    */
   p5.Filter.prototype.process = function(src, freq, res, time) {
@@ -123,8 +122,8 @@ define(function (require) {
    *  Set the frequency and the resonance of the filter.
    *
    *  @method  set
-   *  @param {Number} freq Frequency in Hz, from 10 to 22050
-   *  @param {Number} res  Resonance (Q) from 0.001 to 1000
+   *  @param {Number} [freq] Frequency in Hz, from 10 to 22050
+   *  @param {Number} [res]  Resonance (Q) from 0.001 to 1000
    *  @param {Number} [timeFromNow] schedule this event to happen
    *                                seconds from now
    */
@@ -193,7 +192,7 @@ define(function (require) {
    *  "allpass".
    *
    *  @method  setType
-   *  @param {String}
+   *  @param {String} t
    */
   p5.Filter.prototype.setType = function(t) {
     this.biquad.type = t;
@@ -214,7 +213,8 @@ define(function (require) {
    *  its method <code>setType('lowpass')</code>.
    *  See p5.Filter for methods.
    *
-   *  @method p5.LowPass
+   *  @method LowPass
+   *  @for p5
    */
   p5.LowPass = function() {
     p5.Filter.call(this, 'lowpass');
@@ -227,7 +227,8 @@ define(function (require) {
    *  its method <code>setType('highpass')</code>.
    *  See p5.Filter for methods.
    *
-   *  @method p5.HighPass
+   *  @method HighPass
+   *  @for p5
    */
   p5.HighPass = function() {
     p5.Filter.call(this, 'highpass');
@@ -240,7 +241,8 @@ define(function (require) {
    *  its method <code>setType('bandpass')</code>.
    *  See p5.Filter for methods.
    *
-   *  @method p5.BandPass
+   *  @method BandPass
+   *  @for p5
    */
   p5.BandPass = function() {
     p5.Filter.call(this, 'bandpass');

src/helpers.js

@@ -1,6 +1,9 @@
 'use strict';
 define(function (require) {
   var p5sound = require('master');
+  /**
+   * @class p5
+   */
 
   /**
    * Returns a number representing the sample rate, in samples per second,
@@ -73,8 +76,7 @@ define(function (require) {
    *  converter.
    *
    *  @method soundFormats
-   *  @param {String} formats i.e. 'mp3', 'wav', 'ogg'
-   *  @param {String} formats i.e. 'mp3', 'wav', 'ogg'
+   *  @param {String} [...formats] i.e. 'mp3', 'wav', 'ogg'
    *  @example
    *  <div><code>
    *  function preload() {

src/looper.js

@@ -102,8 +102,7 @@ define(function (require) {
      * strings, or an object with multiple parameters.
      * Zero (0) indicates a rest.
      *
-     * @property sequence
-     * @type {Array}
+     * @property sequence {Array}
      */
     this.sequence = sequence;
   };
@@ -390,7 +389,7 @@ define(function (require) {
    *
    *  @class p5.Score
    *  @constructor
-   *  @param {p5.Part} part(s) One or multiple parts, to be played in sequence.
+   *  @param {p5.Part} [...parts] One or multiple parts, to be played in sequence.
    *  @return {p5.Score}
    */
   p5.Score = function() {

src/master.js

@@ -111,8 +111,7 @@ define(function () {
    *  Web Audio API nodes including a dyanmicsCompressor (<code>.limiter</code>),
    *  and Gain Nodes for <code>.input</code> and <code>.output</code>.
    *
-   *  @property soundOut
-   *  @type {Object}
+   *  @property soundOut {Object}
    */
   p5.prototype.soundOut = p5.soundOut = p5sound;