Skip to content

Commit

Permalink
minor changes to javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
@dennisppaul
dennisppaul committed May 26, 2023
1 parent 2161ae7 commit 8869765
Show file tree
Hide file tree
Showing 5 changed files with 189 additions and 90 deletions.
2 changes: 1 addition & 1 deletion docs/constant-values.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ <h2 title="wellen">wellen.*</h2>
<div class="col-last even-row-color"><code>1024</code></div>
<div class="col-first odd-row-color"><code id="wellen.Wellen.DEFAULT_BITS_PER_SAMPLE">public&nbsp;static&nbsp;final&nbsp;int</code></div>
<div class="col-second odd-row-color"><code><a href="wellen/Wellen.html#DEFAULT_BITS_PER_SAMPLE">DEFAULT_BITS_PER_SAMPLE</a></code></div>
<div class="col-last odd-row-color"><code>24</code></div>
<div class="col-last odd-row-color"><code>16</code></div>
<div class="col-first even-row-color"><code id="wellen.Wellen.DEFAULT_DECAY">public&nbsp;static&nbsp;final&nbsp;float</code></div>
<div class="col-second even-row-color"><code><a href="wellen/Wellen.html#DEFAULT_DECAY">DEFAULT_DECAY</a></code></div>
<div class="col-last even-row-color"><code>0.009999999776482582f</code></div>
Expand Down
34 changes: 26 additions & 8 deletions docs/index-all.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,8 @@ <h2 class="title" id="I:D">D</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Delay.html#%3Cinit%3E(float,float,float)" class="member-name-link">Delay(float, float, float)</a> - Constructor for class wellen.dsp.<a href="wellen/dsp/Delay.html" title="class in wellen.dsp">Delay</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#delete_recording()" class="member-name-link">delete_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Scale.html#DIMINISHED_7" class="member-name-link">DIMINISHED_7</a> - Static variable in class wellen.<a href="wellen/Scale.html" title="class in wellen">Scale</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Distortion.html" class="type-name-link" title="class in wellen.dsp">Distortion</a> - Class in <a href="wellen/dsp/package-summary.html">wellen.dsp</a></dt>
Expand Down Expand Up @@ -572,6 +574,8 @@ <h2 class="title" id="I:E">E</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/Tone.html#enable_reverb(float,float,float)" class="member-name-link">enable_reverb(float, float, float)</a> - Static method in class wellen.<a href="wellen/Tone.html" title="class in wellen">Tone</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#end_recording()" class="member-name-link">end_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Envelope.html" class="type-name-link" title="class in wellen.dsp">Envelope</a> - Class in <a href="wellen/dsp/package-summary.html">wellen.dsp</a></dt>
<dd>
<div class="block">envelope with multiple stages.</div>
Expand Down Expand Up @@ -908,6 +912,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/Beat.html#get_bpm()" class="member-name-link">get_bpm()</a> - Method in class wellen.<a href="wellen/Beat.html" title="class in wellen">Beat</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#get_buffer()" class="member-name-link">get_buffer()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/SAM.html#get_buffer()" class="member-name-link">get_buffer()</a> - Method in class wellen.<a href="wellen/SAM.html" title="class in wellen">SAM</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Tone.html#get_buffer()" class="member-name-link">get_buffer()</a> - Static method in class wellen.<a href="wellen/Tone.html" title="class in wellen">Tone</a></dt>
Expand Down Expand Up @@ -940,8 +946,6 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Envelope.html#get_current_value()" class="member-name-link">get_current_value()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Envelope.html" title="class in wellen.dsp">Envelope</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#get_data()" class="member-name-link">get_data()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/ADSR.html#get_decay()" class="member-name-link">get_decay()</a> - Method in class wellen.dsp.<a href="wellen/dsp/ADSR.html" title="class in wellen.dsp">ADSR</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Instrument.html#get_decay()" class="member-name-link">get_decay()</a> - Method in class wellen.<a href="wellen/Instrument.html" title="class in wellen">Instrument</a></dt>
Expand Down Expand Up @@ -1064,6 +1068,8 @@ <h2 class="title" id="I:G">G</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/Track.html#get_length()" class="member-name-link">get_length()</a> - Method in class wellen.<a href="wellen/Track.html" title="class in wellen">Track</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#get_length_recording()" class="member-name-link">get_length_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/analysis/SoundLevelPressure.html#get_level()" class="member-name-link">get_level()</a> - Method in class wellen.analysis.<a href="wellen/analysis/SoundLevelPressure.html" title="class in wellen.analysis">SoundLevelPressure</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Envelope.html#get_listeners()" class="member-name-link">get_listeners()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Envelope.html" title="class in wellen.dsp">Envelope</a></dt>
Expand Down Expand Up @@ -1525,6 +1531,8 @@ <h2 class="title" id="I:I">I</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/Grid.html#is_quarter(int)" class="member-name-link">is_quarter(int)</a> - Method in class wellen.<a href="wellen/Grid.html" title="class in wellen">Grid</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#is_recording()" class="member-name-link">is_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Grid.html#is_sixteenth(int)" class="member-name-link">is_sixteenth(int)</a> - Method in class wellen.<a href="wellen/Grid.html" title="class in wellen">Grid</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Signal.html#is_stereo()" class="member-name-link">is_stereo()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Signal.html" title="class in wellen.dsp">Signal</a></dt>
Expand Down Expand Up @@ -1571,11 +1579,11 @@ <h2 class="title" id="I:L">L</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#load(byte%5B%5D)" class="member-name-link">load(byte[])</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>
<div class="block">load the sample buffer from *raw* byte data.</div>
<div class="block">load the sample data from *raw* byte data.</div>
</dd>
<dt><a href="wellen/dsp/Sampler.html#load(byte%5B%5D,boolean)" class="member-name-link">load(byte[], boolean)</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>
<div class="block">load the sample buffer from *raw* byte data.</div>
<div class="block">load the sample data from *raw* byte data.</div>
</dd>
<dt><a href="wellen/FFT.html#logAverages(int,int)" class="member-name-link">logAverages(int, int)</a> - Method in class wellen.<a href="wellen/FFT.html" title="class in wellen">FFT</a></dt>
<dd>
Expand Down Expand Up @@ -2145,6 +2153,8 @@ <h2 class="title" id="I:P">P</h2>
<dd>
<div class="block">pause or resume audio processing</div>
</dd>
<dt><a href="wellen/dsp/Sampler.html#pause_recording()" class="member-name-link">pause_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/FFT.html#perform_forward_transform(float%5B%5D)" class="member-name-link">perform_forward_transform(float[])</a> - Static method in class wellen.<a href="wellen/FFT.html" title="class in wellen">FFT</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Instrument.html#pitch_bend(float)" class="member-name-link">pitch_bend(float)</a> - Method in class wellen.<a href="wellen/Instrument.html" title="class in wellen">Instrument</a></dt>
Expand Down Expand Up @@ -2181,6 +2191,8 @@ <h2 class="title" id="I:P">P</h2>
<dd>
<div class="block">Create a new pitch detector for a stream with the defined sample rate.</div>
</dd>
<dt><a href="wellen/dsp/Sampler.html#play()" class="member-name-link">play()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Arpeggiator.html#play(int,int)" class="member-name-link">play(int, int)</a> - Method in class wellen.<a href="wellen/Arpeggiator.html" title="class in wellen">Arpeggiator</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/analysis/FFT.html#powerAndPhaseFromFFT(float%5B%5D,float%5B%5D,float%5B%5D)" class="member-name-link">powerAndPhaseFromFFT(float[], float[], float[])</a> - Method in class wellen.analysis.<a href="wellen/analysis/FFT.html" title="class in wellen.analysis">FFT</a></dt>
Expand Down Expand Up @@ -2311,6 +2323,10 @@ <h2 class="title" id="I:R">R</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/MidiInListener.html#receiveProgramChange(int,int,int)" class="member-name-link">receiveProgramChange(int, int, int)</a> - Method in interface wellen.<a href="wellen/MidiInListener.html" title="interface in wellen">MidiInListener</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#record(float)" class="member-name-link">record(float)</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#record(float%5B%5D)" class="member-name-link">record(float[])</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/ToneEngineDSP.html#register_audioblock_callback(wellen.ToneEngineDSP.AudioOutputCallback)" class="member-name-link">register_audioblock_callback(ToneEngineDSP.AudioOutputCallback)</a> - Method in class wellen.<a href="wellen/ToneEngineDSP.html" title="class in wellen">ToneEngineDSP</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Beat.html#remove(wellen.Beat.Listener)" class="member-name-link">remove(Beat.Listener)</a> - Method in class wellen.<a href="wellen/Beat.html" title="class in wellen">Beat</a></dt>
Expand Down Expand Up @@ -2359,6 +2375,8 @@ <h2 class="title" id="I:R">R</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Vocoder.html#reset_history()" class="member-name-link">reset_history()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Vocoder.html" title="class in wellen.dsp">Vocoder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#resume_recording()" class="member-name-link">resume_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Reverb.html" class="type-name-link" title="class in wellen.dsp">Reverb</a> - Class in <a href="wellen/dsp/package-summary.html">wellen.dsp</a></dt>
<dd>
<div class="block">applies reverb to a signal.</div>
Expand Down Expand Up @@ -2603,6 +2621,8 @@ <h2 class="title" id="I:S">S</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/BeatDSP.html#set_bpm(float)" class="member-name-link">set_bpm(float)</a> - Method in class wellen.dsp.<a href="wellen/dsp/BeatDSP.html" title="class in wellen.dsp">BeatDSP</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#set_buffer(float%5B%5D)" class="member-name-link">set_buffer(float[])</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/FMSynthesis.html#set_carrier(wellen.dsp.Wavetable)" class="member-name-link">set_carrier(Wavetable)</a> - Method in class wellen.dsp.<a href="wellen/dsp/FMSynthesis.html" title="class in wellen.dsp">FMSynthesis</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/InstrumentDSP.html#set_channels(int)" class="member-name-link">set_channels(int)</a> - Method in class wellen.<a href="wellen/InstrumentDSP.html" title="class in wellen">InstrumentDSP</a></dt>
Expand All @@ -2617,8 +2637,6 @@ <h2 class="title" id="I:S">S</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Reverb.html#set_damp(float)" class="member-name-link">set_damp(float)</a> - Method in class wellen.dsp.<a href="wellen/dsp/Reverb.html" title="class in wellen.dsp">Reverb</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#set_data(float%5B%5D)" class="member-name-link">set_data(float[])</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/ADSR.html#set_decay(float)" class="member-name-link">set_decay(float)</a> - Method in class wellen.dsp.<a href="wellen/dsp/ADSR.html" title="class in wellen.dsp">ADSR</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Instrument.html#set_decay(float)" class="member-name-link">set_decay(float)</a> - Method in class wellen.<a href="wellen/Instrument.html" title="class in wellen">Instrument</a></dt>
Expand Down Expand Up @@ -3093,8 +3111,6 @@ <h2 class="title" id="I:S">S</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Envelope.html#start()" class="member-name-link">start()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Envelope.html" title="class in wellen.dsp">Envelope</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#start()" class="member-name-link">start()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Tone.html#start(int)" class="member-name-link">start(int)</a> - Static method in class wellen.<a href="wellen/Tone.html" title="class in wellen">Tone</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Beat.html#start(java.lang.Object)" class="member-name-link">start(Object)</a> - Static method in class wellen.<a href="wellen/Beat.html" title="class in wellen">Beat</a></dt>
Expand Down Expand Up @@ -3139,6 +3155,8 @@ <h2 class="title" id="I:S">S</h2>
<dd>&nbsp;</dd>
<dt><a href="wellen/Tone.html#start(java.lang.String,int,int,int)" class="member-name-link">start(String, int, int, int)</a> - Static method in class wellen.<a href="wellen/Tone.html" title="class in wellen">Tone</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/dsp/Sampler.html#start_recording()" class="member-name-link">start_recording()</a> - Method in class wellen.dsp.<a href="wellen/dsp/Sampler.html" title="class in wellen.dsp">Sampler</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Arpeggiator.html#step()" class="member-name-link">step()</a> - Method in class wellen.<a href="wellen/Arpeggiator.html" title="class in wellen">Arpeggiator</a></dt>
<dd>&nbsp;</dd>
<dt><a href="wellen/Sequencer.html#step()" class="member-name-link">step()</a> - Method in class wellen.<a href="wellen/Sequencer.html" title="class in wellen">Sequencer</a></dt>
Expand Down
2 changes: 1 addition & 1 deletion docs/member-search-index.js
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/wellen/MidiIn.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ <h2>Constructor Summary</h2>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">MidiIn</a><wbr>(int&nbsp;pMidiOutputDeviceID)</code></div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int)" class="member-name-link">MidiIn</a><wbr>(int&nbsp;pMidiInputDeviceID)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">MidiIn</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pMidiOutputDevice)</code></div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String)" class="member-name-link">MidiIn</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pMidiInputDevice)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
Expand Down Expand Up @@ -140,13 +140,13 @@ <h2>Constructor Details</h2>
<li>
<section class="detail" id="&lt;init&gt;(int)">
<h3>MidiIn</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MidiIn</span><wbr><span class="parameters">(int&nbsp;pMidiOutputDeviceID)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MidiIn</span><wbr><span class="parameters">(int&nbsp;pMidiInputDeviceID)</span></div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.lang.String)">
<h3>MidiIn</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MidiIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pMidiOutputDevice)</span></div>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">MidiIn</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;pMidiInputDevice)</span></div>
</section>
</li>
</ul>
Expand Down
Loading

0 comments on commit 8869765

Please sign in to comment.