Here's a complete list of methods that have no JSDoc comment block or have incomplete docs:
| File |
Method |
Issue |
| p5soundNode.js |
connect(destination) |
No JSDoc at all |
| p5soundNode.js |
disconnect() |
No JSDoc at all |
| p5soundNode.js |
getNode() |
No JSDoc at all |
| p5soundSource.js |
start() |
Has a JSDoc tag but no @param, @return, or description text beyond a stub label |
| p5soundSource.js |
stop() |
Same — minimal stub only |
| Envelope.js |
setInput(input) |
Has @method and @param but no description text — just bare tags |
| Noise.js |
type(t) |
Has @method and @param but no description |
| Gain.js |
(the class itself has no methods at all) |
The class body is entirely empty — no amp() or connect() overrides, and those inherited methods are not re-documented for this class |
| AudioIn.js |
start() |
Has @method tag only — no description, no mention of async behavior or mic permissions |
| AudioIn.js |
stop() |
Has @method tag only — no description |
| Utils.js |
clamp(value, min, max) |
No JSDoc at all — it's exported internally but never documented |
| SoundFile.js |
start() |
Has @method but no description, no mention of difference from play() |
| SoundFile.js |
play() |
Has @method but no description — also note start() and play() do identical things, which is undocumented and potentially confusing |
| SoundFile.js |
stop() |
Has @method but no description |
| SoundFile.js |
channels() |
Has @method and @return but no description |
| Panner3D.js |
process(input) |
Documented but the description ("Connects an input source") duplicates connect() — no rationale for this separate method |
| FFT.js |
waveform() |
Has a typo in @return: says "from -1 to -1" instead of "-1 to 1" — functionally broken doc |
hey @ogbabydiesal do you wanna add or discard anything?
Here's a complete list of methods that have no JSDoc comment block or have incomplete docs:
hey @ogbabydiesal do you wanna add or discard anything?