orastron/brickworks
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

fixed documentation typos in bw_ls2

Browse Source
This commit is contained in:
Stefano D'Angelo 2023-10-27 15:48:32 +02:00
parent 891fa64c9b
commit 0cb5a29a8b
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
include/bw_ls2.h
View File

@ -20,7 +20,7 @@
/*! /*!
* module_type {{{ dsp }}} * module_type {{{ dsp }}}
* version {{{ 1.0.0 }}} * version {{{ 1.0.1 }}}
* requires {{{ bw_common bw_gain bw_math bw_mm2 bw_one_pole bw_svf }}} * requires {{{ bw_common bw_gain bw_math bw_mm2 bw_one_pole bw_svf }}}
* description {{{ * description {{{
* Second-order low shelf filter (12 dB/oct) with gain asymptotically * Second-order low shelf filter (12 dB/oct) with gain asymptotically
@ -28,6 +28,14 @@
* }}} * }}}
* changelog {{{ * changelog {{{
* <ul> * <ul>
* <li>Version <strong>1.0.1</strong>:
* <ul>
* <li>Fixed typos in documentation of
* <code>bw_ls2_set_cutoff()</code>,
* <code>bw_ls2_set_dc_gain_lin()</code>, and
* <code>bw_ls2_set_dc_gain_dB()</code>.</li>
* </ul>
* </li>
* <li>Version <strong>1.0.0</strong>: * <li>Version <strong>1.0.0</strong>:
* <ul> * <ul>
* <li>Added <code>bw_ls2_reset_state_multi()</code> and updated C++ * <li>Added <code>bw_ls2_reset_state_multi()</code> and updated C++
@ -214,7 +222,7 @@ static inline void bw_ls2_set_cutoff(
* *
* `value` must be finite and positive. * `value` must be finite and positive.
* *
* By the time ``bw_ls2_reset_coeffs(), `bw_ls2_update_coeffs_ctrl()`, * By the time `bw_ls2_reset_coeffs()`, `bw_ls2_update_coeffs_ctrl()`,
* `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`, * `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`,
* or `bw_ls2_process_multi()` is called, * or `bw_ls2_process_multi()` is called,
* `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`, * `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,
@ -270,7 +278,7 @@ static inline void bw_ls2_set_dc_gain_lin(
* *
* Valid range: [`1e-30f`, `1e30f`]. * Valid range: [`1e-30f`, `1e30f`].
* *
* By the time ``bw_ls2_reset_coeffs(), `bw_ls2_update_coeffs_ctrl()`, * By the time `bw_ls2_reset_coeffs()`, `bw_ls2_update_coeffs_ctrl()`,
* `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`, * `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`,
* or `bw_ls2_process_multi()` is called, * or `bw_ls2_process_multi()` is called,
* `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`, * `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,
@ -288,7 +296,7 @@ static inline void bw_ls2_set_dc_gain_dB(
* *
* Valid range: [`-600.f`, `600.f`]. * Valid range: [`-600.f`, `600.f`].
* *
* By the time ``bw_ls2_reset_coeffs(), `bw_ls2_update_coeffs_ctrl()`, * By the time `bw_ls2_reset_coeffs()`, `bw_ls2_update_coeffs_ctrl()`,
* `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`, * `bw_ls2_update_coeffs_audio()`, `bw_ls2_process1()`, `bw_ls2_process()`,
* or `bw_ls2_process_multi()` is called, * or `bw_ls2_process_multi()` is called,
* `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`, * `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,