Improve functions documentation, regenerate.

grame-cncm · May 30, 2021 · 55a81fb · 55a81fb
1 parent b707357
commit 55a81fb
Show file tree

Hide file tree

Showing 58 changed files with 319 additions and 306 deletions.
diff --git a/analyzers.lib b/analyzers.lib
@@ -35,7 +35,7 @@ Michon and Julius O. Smith III, and is released under the
 // #### Usage
 //
 // ```
-// _ : abs_envelope_rect(period) : _;
+// _ : abs_envelope_rect(period) : _
 // ```
 //
 //  Where:
@@ -57,7 +57,7 @@ abs_envelope_rect(period, x) = abs(x) : fi.avg_rect(period);
 // #### Usage
 //
 // ```
-// _ : abs_envelope_tau(period) : _;
+// _ : abs_envelope_tau(period) : _
 // ```
 //
 //  Where:
@@ -79,7 +79,7 @@ abs_envelope_tau(period, x) = abs(x) : fi.avg_tau(period);
 // #### Usage
 //
 // ```
-// _ : abs_envelope_t60(period) : _;
+// _ : abs_envelope_t60(period) : _
 // ```
 //
 //  Where:
@@ -101,7 +101,7 @@ abs_envelope_t60(period, x) = abs(x) : fi.avg_t60(period);
 // #### Usage
 //
 // ```
-// _ : abs_envelope_t19(period) : _;
+// _ : abs_envelope_t19(period) : _
 // ```
 //
 //  Where:
@@ -184,7 +184,7 @@ amp_follower_ud(att,rel) = amp_follower(rel) : si.smooth(ba.tau2pole(att));
 // #### Usage
 //
 // ```
-// _ : amp_follower_ar(att,rel) : _;
+// _ : amp_follower_ar(att,rel) : _
 // ```
 // * Author Jonatan Liljedahl, revised by RM
 //---------------------------------------------------------
@@ -197,7 +197,7 @@ amp_follower_ar(att,rel) = abs : si.lag_ud(att,rel);
 // #### Usage
 //
 // ```
-// _ : ms_envelope_rect(period) : _;
+// _ : ms_envelope_rect(period) : _
 // ```
 //
 //  Where:
@@ -219,7 +219,7 @@ ms_envelope_rect(period, x) = x * x : fi.avg_rect(period);
 // #### Usage
 //
 // ```
-// _ : ms_envelope_tau(period) : _;
+// _ : ms_envelope_tau(period) : _
 // ```
 //
 //  Where:
@@ -241,7 +241,7 @@ ms_envelope_tau(period, x) = x * x : fi.avg_tau(period);
 // #### Usage
 //
 // ```
-// _ : ms_envelope_t60(period) : _;
+// _ : ms_envelope_t60(period) : _
 // ```
 //
 //  Where:
@@ -263,7 +263,7 @@ ms_envelope_t60(period, x) = x * x : fi.avg_t60(period);
 // #### Usage
 //
 // ```
-// _ : ms_envelope_t19(period) : _;
+// _ : ms_envelope_t19(period) : _
 // ```
 //
 //  Where:
@@ -284,7 +284,7 @@ ms_envelope_t19(period, x) = x * x : fi.avg_t19(period);
 // #### Usage
 //
 // ```
-// _ : rms_envelope_rect(period) : _;
+// _ : rms_envelope_rect(period) : _
 // ```
 //
 //  Where:
@@ -306,7 +306,7 @@ rms_envelope_rect(period, x) = ms_envelope_rect(period, x) : sqrt;
 // #### Usage
 //
 // ```
-// _ : rms_envelope_tau(period) : _;
+// _ : rms_envelope_tau(period) : _
 // ```
 //
 //  Where:
@@ -328,7 +328,7 @@ rms_envelope_tau(period, x) = ms_envelope_tau(period, x) : sqrt;
 // #### Usage
 //
 // ```
-// _ : rms_envelope_t60(period) : _;
+// _ : rms_envelope_t60(period) : _
 // ```
 //
 //  Where:
@@ -350,7 +350,7 @@ rms_envelope_t60(period, x) = ms_envelope_t60(period, x) : sqrt;
 // #### Usage
 //
 // ```
-// _ : rms_envelope_t19(period) : _;
+// _ : rms_envelope_t19(period) : _
 // ```
 //
 //  Where:
@@ -378,7 +378,7 @@ rms_envelope_t19(period, x) = ms_envelope_t19(period, x) : sqrt;
 // #### Usage
 //
 // ```
-// _ : zcr(tau) : _;
+// _ : zcr(tau) : _
 // ```
 //
 // Where:
@@ -437,15 +437,15 @@ zcr(period, x) = ma.zc(x) : fi.lptau(period);
 //
 // #### Usage
 // ```
-// _ : mth_octave_analyzer(O,M,ftop,N) : par(i,N,_); // Oth-order Butterworth
-// _ : mth_octave_analyzer6e(M,ftop,N) : par(i,N,_); // 6th-order elliptic
+// _ : mth_octave_analyzer(O,M,ftop,N) : par(i,N,_) // Oth-order Butterworth
+// _ : mth_octave_analyzer6e(M,ftop,N) : par(i,N,_) // 6th-order elliptic
 // ```
 //
 // Also for convenience:
 //
 // ```
-// _ : mth_octave_analyzer3(M,ftop,N) : par(i,N,_); // 3d-order Butterworth
-// _ : mth_octave_analyzer5(M,ftop,N) : par(i,N,_); // 5th-roder Butterworth
+// _ : mth_octave_analyzer3(M,ftop,N) : par(i,N,_) // 3d-order Butterworth
+// _ : mth_octave_analyzer5(M,ftop,N) : par(i,N,_) // 5th-roder Butterworth
 // mth_octave_analyzer_default = mth_octave_analyzer6e;
 // ```
 //
@@ -491,7 +491,7 @@ mth_octave_analyzer_default = mth_octave_analyzer6e; // default analyzer
 // #### Usage:
 //
 // ```
-// _ : mth_octave_spectral_level6e(M,ftop,NBands,tau,dB_offset) : _;
+// _ : mth_octave_spectral_level6e(M,ftop,NBands,tau,dB_offset) : _
 // ```
 //
 // Where:
@@ -575,7 +575,7 @@ octave_analyzer(N) = mth_octave_analyzer_default(1,10000,N);
 // #### Usage
 //
 // ```
-// _ : analyzer(O,freqs) : par(i,N,_); // No delay equalizer
+// _ : analyzer(O,freqs) : par(i,N,_) // No delay equalizer
 // ```
 //
 // Where:
@@ -611,7 +611,7 @@ analyzer(O,lfreqs) = _ <: bsplit(nb) with
 // #### Usage
 //
 // ```
-// _ : goertzelOpt(freq,N) : _;
+// _ : goertzelOpt(freq,N) : _
 // ```
 //
 // Where:
@@ -644,7 +644,7 @@ with{
 // #### Usage
 //
 // ```
-// _ : goertzelComp(freq,N) : _;
+// _ : goertzelComp(freq,N) : _
 // ```
 //
 // Where:
@@ -681,7 +681,7 @@ with{
 // #### Usage
 //
 // ```
-// _ : goertzel(freq,N) : _;
+// _ : goertzel(freq,N) : _
 // ```
 //
 // Where:
@@ -726,7 +726,7 @@ c_bit_reverse_shuffle(N) = si.cbus(N) <: par(i,N,c_bit_reverse_permuter(N,i)) wi
 // #### Usage
 //
 // ```
-// si.cbus(N) : fft(N) : si.cbus(N);
+// si.cbus(N) : fft(N) : si.cbus(N)
 // ```
 //
 // Where:
@@ -782,7 +782,7 @@ with {
 // #### Usage
 //
 // ```
-// si.cbus(N) : ifft(N) : si.cbus(N);
+// si.cbus(N) : ifft(N) : si.cbus(N)
 // ```
 //
 // Where:

diff --git a/basics.lib b/basics.lib
@@ -689,7 +689,7 @@ subseq(head, 0, n)         = head;
 // #### Usage
 //
 // ```
-// tabulate(C, fun, size, r0, r1, x).(val | lin | cub)
+// tabulate(C, fun, size, r0, r1, x).(val|lin|cub) : _
 // ```
 //
 // Where:

diff --git a/compressors.lib b/compressors.lib
@@ -742,7 +742,7 @@ with {
 // #### Usage
 //
 // ```
-//  _ : limiter_1176_R4_mono : _;
+//  _ : limiter_1176_R4_mono : _
 // ```
 //
 // #### Reference:
@@ -774,7 +774,7 @@ limiter_1176_R4_mono = compressor_mono(4,-6,0.0008,0.5);
 // #### Usage
 //
 // ```
-//  _,_ : limiter_1176_R4_stereo : _,_;
+//  _,_ : limiter_1176_R4_stereo : _,_
 // ```
 //
 // #### Reference:
@@ -823,7 +823,7 @@ limiter_1176_R4_stereo = compressor_stereo(4,-6,0.0008,0.5);
 //
 // ```
 // si.bus(N) : limiter_lad_N(N, LD, ceiling, attack, hold, release) : 
-//    si.bus(N);
+//    si.bus(N)
 // ```
 //
 // Where:
@@ -866,7 +866,7 @@ limiter_lad_N(N, LD, ceiling, attack, hold, release) =
 // #### Usage
 //
 // ```
-// _ : limiter_lad_mono(LD, ceiling, attack, hold, release) : _;
+// _ : limiter_lad_mono(LD, ceiling, attack, hold, release) : _
 // ```
 //
 // Where:
@@ -894,7 +894,7 @@ limiter_lad_mono(LD) = limiter_lad_N(1, LD);
 // #### Usage
 //
 // ```
-// _ , _ : limiter_lad_stereo(LD, ceiling, attack, hold, release) : _ , _;
+// _,_ : limiter_lad_stereo(LD, ceiling, attack, hold, release) : _,_
 // ```
 //
 // Where:
@@ -923,7 +923,7 @@ limiter_lad_stereo(LD) = limiter_lad_N(2, LD);
 //
 // ```
 // si.bus(4) : limiter_lad_quad(LD, ceiling, attack, hold, release) : 
-//    si.bus(4);
+//    si.bus(4)
 // ```
 //
 // Where:
@@ -959,7 +959,7 @@ limiter_lad_quad(LD) = limiter_lad_N(4, LD);
 // #### Usage
 //
 // ```
-// _ : limiter_lad_bw : _;
+// _ : limiter_lad_bw : _
 // ```
 //
 // #### Reference:
@@ -971,6 +971,6 @@ declare limiter_lad_bw copyright "Copyright (C) 2020 Dario Sanfilippo
       <[email protected]>";
 declare limiter_lad_bw license "GPLv3 license";
 limiter_lad_bw = limiter_lad_mono(.01, 1, .01 / twopi, .1, 1 / twopi)
-      with {
-           twopi = 2 * ma.PI;
-      };
+with {
+    twopi = 2 * ma.PI;
+};