Skip to content

Commit 4fc5418

Browse files
committed
move yuidoc module declaration to fragments/before.frag
1 parent 7f3a187 commit 4fc5418

File tree

2 files changed

+66
-62
lines changed

2 files changed

+66
-62
lines changed

fragments/before.frag

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,68 @@
1+
/**
2+
* p5.sound extends p5 with <a href="http://caniuse.com/audio-api"
3+
* target="_blank">Web Audio</a> functionality including audio input,
4+
* playback, analysis and synthesis.
5+
* <br/><br/>
6+
* <a href="#/p5.SoundFile"><b>p5.SoundFile</b></a>: Load and play sound files.<br/>
7+
* <a href="#/p5.Amplitude"><b>p5.Amplitude</b></a>: Get the current volume of a sound.<br/>
8+
* <a href="#/p5.AudioIn"><b>p5.AudioIn</b></a>: Get sound from an input source, typically
9+
* a computer microphone.<br/>
10+
* <a href="#/p5.FFT"><b>p5.FFT</b></a>: Analyze the frequency of sound. Returns
11+
* results from the frequency spectrum or time domain (waveform).<br/>
12+
* <a href="#/p5.Oscillator"><b>p5.Oscillator</b></a>: Generate Sine,
13+
* Triangle, Square and Sawtooth waveforms. Base class of
14+
* <a href="#/p5.Noise">p5.Noise</a> and <a href="#/p5.Pulse">p5.Pulse</a>.
15+
* <br/>
16+
* <a href="#/p5.Env"><b>p5.Env</b></a>: An Envelope is a series
17+
* of fades over time. Often used to control an object's
18+
* output gain level as an "ADSR Envelope" (Attack, Decay,
19+
* Sustain, Release). Can also modulate other parameters.<br/>
20+
* <a href="#/p5.Delay"><b>p5.Delay</b></a>: A delay effect with
21+
* parameters for feedback, delayTime, and lowpass filter.<br/>
22+
* <a href="#/p5.Filter"><b>p5.Filter</b></a>: Filter the frequency range of a
23+
* sound.
24+
* <br/>
25+
* <a href="#/p5.Reverb"><b>p5.Reverb</b></a>: Add reverb to a sound by specifying
26+
* duration and decay. <br/>
27+
* <b><a href="#/p5.Convolver">p5.Convolver</a>:</b> Extends
28+
* <a href="#/p5.Reverb">p5.Reverb</a> to simulate the sound of real
29+
* physical spaces through convolution.<br/>
30+
* <b><a href="#/p5.SoundRecorder">p5.SoundRecorder</a></b>: Record sound for playback
31+
* / save the .wav file.
32+
* <b><a href="#/p5.Phrase">p5.Phrase</a></b>, <b><a href="#/p5.Part">p5.Part</a></b> and
33+
* <b><a href="#/p5.Score">p5.Score</a></b>: Compose musical sequences.
34+
* <br/><br/>
35+
* p5.sound is on <a href="https://github.com/therewasaguy/p5.sound/">GitHub</a>.
36+
* Download the latest version
37+
* <a href="https://github.com/therewasaguy/p5.sound/blob/master/lib/p5.sound.js">here</a>.
38+
*
39+
* @module p5.sound
40+
* @submodule p5.sound
41+
* @for p5.sound
42+
* @main
43+
*/
44+
45+
/**
46+
* p5.sound
47+
* https://p5js.org/reference/#/libraries/p5.sound
48+
*
49+
* From the Processing Foundation and contributors
50+
* https://github.com/processing/p5.js-sound/graphs/contributors
51+
*
52+
* MIT License (MIT)
53+
* https://github.com/processing/p5.js-sound/blob/master/LICENSE
54+
*
55+
* Some of the many audio libraries & resources that inspire p5.sound:
56+
* - TONE.js (c) Yotam Mann. Licensed under The MIT License (MIT). https://github.com/TONEnoTONE/Tone.js
57+
* - buzz.js (c) Jay Salvat. Licensed under The MIT License (MIT). http://buzz.jaysalvat.com/
58+
* - Boris Smus Web Audio API book, 2013. Licensed under the Apache License http://www.apache.org/licenses/LICENSE-2.0
59+
* - wavesurfer.js https://github.com/katspaugh/wavesurfer.js
60+
* - Web Audio Components by Jordan Santell https://github.com/web-audio-components
61+
* - Wilm Thoben's Sound library for Processing https://github.com/processing/processing/tree/master/java/libraries/sound
62+
*
63+
* Web Audio API: http://w3.org/TR/webaudio/
64+
*/
65+
166
(function (root, factory) {
267
if (typeof define === 'function' && define.amd)
368
define('p5.sound', ['p5'], function (p5) { (factory(p5));});
@@ -6,4 +71,4 @@
671
else
772
factory(root['p5']);
873
}(this, function (p5) {
9-
74+

src/sndcore.js

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,5 @@
11
'use strict';
22

3-
/**
4-
* p5.sound extends p5 with <a href="http://caniuse.com/audio-api"
5-
* target="_blank">Web Audio</a> functionality including audio input,
6-
* playback, analysis and synthesis.
7-
* <br/><br/>
8-
* <a href="#/p5.SoundFile"><b>p5.SoundFile</b></a>: Load and play sound files.<br/>
9-
* <a href="#/p5.Amplitude"><b>p5.Amplitude</b></a>: Get the current volume of a sound.<br/>
10-
* <a href="#/p5.AudioIn"><b>p5.AudioIn</b></a>: Get sound from an input source, typically
11-
* a computer microphone.<br/>
12-
* <a href="#/p5.FFT"><b>p5.FFT</b></a>: Analyze the frequency of sound. Returns
13-
* results from the frequency spectrum or time domain (waveform).<br/>
14-
* <a href="#/p5.Oscillator"><b>p5.Oscillator</b></a>: Generate Sine,
15-
* Triangle, Square and Sawtooth waveforms. Base class of
16-
* <a href="#/p5.Noise">p5.Noise</a> and <a href="#/p5.Pulse">p5.Pulse</a>.
17-
* <br/>
18-
* <a href="#/p5.Env"><b>p5.Env</b></a>: An Envelope is a series
19-
* of fades over time. Often used to control an object's
20-
* output gain level as an "ADSR Envelope" (Attack, Decay,
21-
* Sustain, Release). Can also modulate other parameters.<br/>
22-
* <a href="#/p5.Delay"><b>p5.Delay</b></a>: A delay effect with
23-
* parameters for feedback, delayTime, and lowpass filter.<br/>
24-
* <a href="#/p5.Filter"><b>p5.Filter</b></a>: Filter the frequency range of a
25-
* sound.
26-
* <br/>
27-
* <a href="#/p5.Reverb"><b>p5.Reverb</b></a>: Add reverb to a sound by specifying
28-
* duration and decay. <br/>
29-
* <b><a href="#/p5.Convolver">p5.Convolver</a>:</b> Extends
30-
* <a href="#/p5.Reverb">p5.Reverb</a> to simulate the sound of real
31-
* physical spaces through convolution.<br/>
32-
* <b><a href="#/p5.SoundRecorder">p5.SoundRecorder</a></b>: Record sound for playback
33-
* / save the .wav file.
34-
* <b><a href="#/p5.Phrase">p5.Phrase</a></b>, <b><a href="#/p5.Part">p5.Part</a></b> and
35-
* <b><a href="#/p5.Score">p5.Score</a></b>: Compose musical sequences.
36-
* <br/><br/>
37-
* p5.sound is on <a href="https://github.com/therewasaguy/p5.sound/">GitHub</a>.
38-
* Download the latest version
39-
* <a href="https://github.com/therewasaguy/p5.sound/blob/master/lib/p5.sound.js">here</a>.
40-
*
41-
* @module p5.sound
42-
* @submodule p5.sound
43-
* @for p5.sound
44-
* @main
45-
*/
46-
47-
48-
/**
49-
* p5.sound developed by Jason Sigal for the Processing Foundation, Google Summer of Code 2014. The MIT License (MIT).
50-
*
51-
* http://github.com/therewasaguy/p5.sound
52-
*
53-
* Some of the many audio libraries & resources that inspire p5.sound:
54-
* - TONE.js (c) Yotam Mann, 2014. Licensed under The MIT License (MIT). https://github.com/TONEnoTONE/Tone.js
55-
* - buzz.js (c) Jay Salvat, 2013. Licensed under The MIT License (MIT). http://buzz.jaysalvat.com/
56-
* - Boris Smus Web Audio API book, 2013. Licensed under the Apache License http://www.apache.org/licenses/LICENSE-2.0
57-
* - wavesurfer.js https://github.com/katspaugh/wavesurfer.js
58-
* - Web Audio Components by Jordan Santell https://github.com/web-audio-components
59-
* - Wilm Thoben's Sound library for Processing https://github.com/processing/processing/tree/master/java/libraries/sound
60-
*
61-
* Web Audio API: http://w3.org/TR/webaudio/
62-
*/
63-
643
define(function () {
654

665
/* AudioContext Monkeypatch

0 commit comments

Comments
 (0)