Skip to content

Commit 87e0e0b

Browse files
Spongmantherewasaguy
authored andcommitted
docs: fix property types
1 parent f0e0f67 commit 87e0e0b

File tree

7 files changed

+10
-10
lines changed

7 files changed

+10
-10
lines changed

src/delay.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ define(function (require) {
6767
* <a href="http://www.w3.org/TR/webaudio/#DelayNode">
6868
* Web Audio Delay Nodes</a>, one for each stereo channel.
6969
*
70-
* @property leftDelay {Object} Web Audio Delay Node
70+
* @property {DelayNode} leftDelay
7171
*/
7272
this.leftDelay = this.ac.createDelay();
7373
/**
7474
* The p5.Delay is built with two
7575
* <a href="http://www.w3.org/TR/webaudio/#DelayNode">
7676
* Web Audio Delay Nodes</a>, one for each stereo channel.
7777
*
78-
* @property rightDelay {Object} Web Audio Delay Node
78+
* @property {DelayNode} rightDelay
7979
*/
8080
this.rightDelay = this.ac.createDelay();
8181

src/distortion.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ define(function (require) {
5959
* <a href="http://www.w3.org/TR/webaudio/#WaveShaperNode">
6060
* Web Audio WaveShaper Node</a>.
6161
*
62-
* @property WaveShaperNode {Object} AudioNode
62+
* @property {AudioNode} WaveShaperNode
6363
*/
6464
this.waveShaperNode = this.ac.createWaveShaper();
6565

src/effect.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ define(function (require) {
2222
/**
2323
* The p5.Effect class is built
2424
* using Tone.js CrossFade
25-
* @property _drywet {Object} ToneJS node
25+
* @property {CrossFade} _drywet
2626
*/
2727
this._drywet = new CrossFade(1);
2828

2929
/**
3030
* In classes that extend
3131
* p5.Effect, connect effect nodes
3232
* to the wet parameter
33-
* @property wet {Object} Web Audio Gain Node
33+
* @property {GainNode} wet
3434
*/
3535
this.wet = this.ac.createGain();
3636

src/filter.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ define(function (require) {
8686
* <a href="http://www.w3.org/TR/webaudio/#BiquadFilterNode">
8787
* Web Audio BiquadFilter Node</a>.
8888
*
89-
* @property biquadFilter {Object} Web Audio Delay Node
89+
* @property {DelayNode} biquadFilter
9090
*/
9191

9292
this.biquad = this.ac.createBiquadFilter();

src/looper.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ define(function (require) {
102102
* strings, or an object with multiple parameters.
103103
* Zero (0) indicates a rest.
104104
*
105-
* @property sequence {Array}
105+
* @property {Array} sequence
106106
*/
107107
this.sequence = sequence;
108108
};

src/master.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ define(function () {
111111
* Web Audio API nodes including a dyanmicsCompressor (<code>.limiter</code>),
112112
* and Gain Nodes for <code>.input</code> and <code>.output</code>.
113113
*
114-
* @property soundOut {Object}
114+
* @property {Object} soundOut
115115
*/
116116
p5.prototype.soundOut = p5.soundOut = p5sound;
117117

src/reverb.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ define(function (require) {
236236
* <a href="http://www.w3.org/TR/webaudio/#ConvolverNode">
237237
* Web Audio Convolver Node</a>.
238238
*
239-
* @property convolverNode {Object} Web Audio Convolver Node
239+
* @property {ConvolverNode} convolverNod
240240
*/
241241
this.convolverNode = this.ac.createConvolver();
242242

@@ -433,7 +433,7 @@ define(function (require) {
433433
* they will be stored as Objects in this Array. Toggle between them
434434
* with the <code>toggleImpulse(id)</code> method.
435435
*
436-
* @property impulses {Array} Array of Web Audio Buffers
436+
* @property {Array} impulses
437437
*/
438438
p5.Convolver.prototype.impulses = [];
439439

0 commit comments

Comments
 (0)