Skip to content

Commit f0e0f67

Browse files
piershtherewasaguy
authored andcommitted
docs: remove @returns from @constructors, add @extends
1 parent 4fc5418 commit f0e0f67

16 files changed

+10
-14
lines changed

src/amplitude.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ define(function (require) {
1313
* @constructor
1414
* @param {Number} [smoothing] between 0.0 and .999 to smooth
1515
* amplitude readings (defaults to 0)
16-
* @return {Object} Amplitude Object
1716
* @example
1817
* <div><code>
1918
* var sound, amplitude, cnv;

src/audioin.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ define(function (require) {
2424
* accessing the AudioIn. For example,
2525
* Safari and iOS devices do not
2626
* currently allow microphone access.
27-
* @return {Object} AudioIn
2827
* @example
2928
* <div><code>
3029
* var mic;

src/compressor.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ define(function (require) {
1818
* https://www.w3.org/TR/webaudio/#the-dynamicscompressornode-interface
1919
*
2020
* @class p5.Compressor
21+
* @extends p5.Effect
2122
* @constructor
22-
* @return {Object} Returns a p5.Compressor object
2323
*
2424
* @example
2525
* <div><code>

src/delay.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ define(function (require) {
1515
* original source.
1616
*
1717
* @class p5.Delay
18+
* @extends p5.Effect
1819
* @constructor
19-
* @return {Object} Returns a p5.Delay object
2020
* @example
2121
* <div><code>
2222
* var noise, env, delay;

src/distortion.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ define(function (require) {
2727
* [Kevin Ennis](http://stackoverflow.com/questions/22312841/waveshaper-node-in-webaudio-how-to-emulate-distortion)
2828
*
2929
* @class p5.Distortion
30+
* @extends p5.Effect
3031
* @constructor
3132
* @param {Number} [amount=0.25] Unbounded distortion amount.
3233
* Normal values range from 0-1.
3334
* @param {String} [oversample='none'] 'none', '2x', or '4x'.
3435
*
35-
* @return {Object} Distortion object
3636
*/
3737
p5.Distortion = function(amount, oversample) {
3838
Effect.call(this);

src/effect.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ define(function (require) {
1111
*
1212
* @class p5.Effect
1313
* @constructor
14-
* @return {Object} Returns a p5.Effect object
1514
*
1615
*/
1716
p5.Effect = function() {

src/errorHandler.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ define(function () {
3636
});
3737
err.stack = splitStack.join('\n');
3838

39-
return err;
39+
return err; // TODO: is this really a constructor?
4040
};
4141

4242
return CustomError;

src/fft.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ define(function (require) {
3939
* @param {Number} [bins] Length of resulting array.
4040
* Must be a power of two between
4141
* 16 and 1024. Defaults to 1024.
42-
* @return {Object} FFT Object
4342
* @example
4443
* <div><code>
4544
* function preload(){

src/filter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ define(function (require) {
2121
* bandpass, or resonance of the low/highpass cutoff frequency.
2222
*
2323
* @class p5.Filter
24+
* @extends p5.Effect
2425
* @constructor
2526
* @param {String} [type] 'lowpass' (default), 'highpass', 'bandpass'
26-
* @return {Object} p5.Filter
2727
* @example
2828
* <div><code>
2929
* var fft, noise, filter;

src/looper.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,6 @@ define(function (require) {
390390
* @class p5.Score
391391
* @constructor
392392
* @param {p5.Part} [...parts] One or multiple parts, to be played in sequence.
393-
* @return {p5.Score}
394393
*/
395394
p5.Score = function() {
396395
// for all of the arguments

0 commit comments

Comments
 (0)