fix asterisk-escaping typos in doc

include/bw_hs1.h

@@ -31,6 +31,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -244,8 +245,8 @@ static inline void bw_hs1_set_cutoff(
  *
  *    `value` must be finite and positive.
  *
- *    By the time `bw_hs1_reset_\*()`, `bw_hs1_update_coeffs_\*()`, or
+ *    By the time `bw_hs1_reset_*()`, `bw_hs1_update_coeffs_*()`, or
- *    `bw_hs1_process\*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
+ *    `bw_hs1_process*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
  *    [`1e-6f`, `1e12f`].
  *
  *    Default value: `1e3f`.
@@ -287,8 +288,8 @@ static inline void bw_hs1_set_high_gain_lin(
  *
  *    Valid range: [`1e-30f`, `1e30f`].
  *
- *    By the time `bw_hs1_reset_\*()`, `bw_hs1_update_coeffs_\*()`, or
+ *    By the time `bw_hs1_reset_*()`, `bw_hs1_update_coeffs_*()`, or
- *    `bw_hs1_process\*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
+ *    `bw_hs1_process*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
  *    [`1e-6f`, `1e12f`].
  *
  *    Default value: `1.f`.
@@ -304,8 +305,8 @@ static inline void bw_hs1_set_high_gain_dB(
  *
  *    Valid range: [`-600.f`, `600.f`].
  *
- *    By the time `bw_hs1_reset_\*()`, `bw_hs1_update_coeffs_\*()`, or
+ *    By the time `bw_hs1_reset_*()`, `bw_hs1_update_coeffs_*()`, or
- *    `bw_hs1_process\*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
+ *    `bw_hs1_process*()` is called, `cutoff * bw_sqrtf(high_gain)` must be in
  *    [`1e-6f`, `1e12f`].
  *
  *    Default value: `0.f`.

include/bw_hs2.h

@@ -31,6 +31,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -248,8 +249,8 @@ static inline void bw_hs2_set_cutoff(
  *
  *    `value` must be finite and positive.
  *
- *    By the time `bw_hs2_reset_\*()`, `bw_hs2_update_coeffs_\*()`, or
+ *    By the time `bw_hs2_reset_*()`, `bw_hs2_update_coeffs_*()`, or
- *    `bw_hs2_process\*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
+ *    `bw_hs2_process*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `1e3f`.
@@ -303,8 +304,8 @@ static inline void bw_hs2_set_high_gain_lin(
  *
  *    Valid range: [`1e-30f`, `1e30f`].
  *
- *    By the time `bw_hs2_reset_\*()`, `bw_hs2_update_coeffs_\*()`, or
+ *    By the time `bw_hs2_reset_*()`, `bw_hs2_update_coeffs_*()`, or
- *    `bw_hs2_process\*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
+ *    `bw_hs2_process*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `1.f`.
@@ -320,8 +321,8 @@ static inline void bw_hs2_set_high_gain_dB(
  *
  *    Valid range: [`-600.f`, `600.f`].
  *
- *    By the time `bw_hs2_reset_\*()`, `bw_hs2_update_coeffs_\*()`, or
+ *    By the time `bw_hs2_reset_*()`, `bw_hs2_update_coeffs_*()`, or
- *    `bw_hs2_process\*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
+ *    `bw_hs2_process*()` is called, `cutoff * bw_sqrtf(bw_sqrtf(high_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `0.f`.

include/bw_ls1.h

@@ -32,6 +32,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -245,8 +246,8 @@ static inline void bw_ls1_set_cutoff(
  *
  *    `value` must be finite and positive.
  *
- *    By the time `bw_ls1_reset_\*()`, `bw_ls1_update_coeffs_\*()`, or
+ *    By the time `bw_ls1_reset_*()`, `bw_ls1_update_coeffs_*()`, or
- *    `bw_ls1_process\*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
+ *    `bw_ls1_process*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `1e3f`.
@@ -287,8 +288,8 @@ static inline void bw_ls1_set_dc_gain_lin(
  *
  *    Valid range: [`1e-30f`, `1e30f`].
  *
- *    By the time `bw_ls1_reset_\*()`, `bw_ls1_update_coeffs_\*()`, or
+ *    By the time `bw_ls1_reset_*()`, `bw_ls1_update_coeffs_*()`, or
- *    `bw_ls1_process\*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
+ *    `bw_ls1_process*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `1.f`.
@@ -303,8 +304,8 @@ static inline void bw_ls1_set_dc_gain_dB(
  *
  *    Valid range: [`-600.f`, `600.f`].
  *
- *    By the time `bw_ls1_reset_\*()`, `bw_ls1_update_coeffs_\*()`, or
+ *    By the time `bw_ls1_reset_*()`, `bw_ls1_update_coeffs_*()`, or
- *    `bw_ls1_process\*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
+ *    `bw_ls1_process*()` is called, `cutoff * bw_rcpf(bw_sqrtf(dc_gain))`
  *    must be in [`1e-6f`, `1e12f`].
  *
  *    Default value: `0.f`.

include/bw_ls2.h

@@ -32,6 +32,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -253,8 +254,8 @@ static inline void bw_ls2_set_cutoff(
  *
  *    `value` must be finite and positive.
  *
- *    By the time `bw_ls2_reset_\*()`, `bw_ls2_update_coeffs_\*()`, or
+ *    By the time `bw_ls2_reset_*()`, `bw_ls2_update_coeffs_*()`, or
- *    `bw_ls2_process\*()` is called,
+ *    `bw_ls2_process*()` is called,
  *    `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,
  *    `1e12f`].
  *
@@ -308,8 +309,8 @@ static inline void bw_ls2_set_dc_gain_lin(
  *
  *    Valid range: [`1e-30f`, `1e30f`].
  *
- *    By the time `bw_ls2_reset_\*()`, `bw_ls2_update_coeffs_\*()`, or
+ *    By the time `bw_ls2_reset_*()`, `bw_ls2_update_coeffs_*()`, or
- *    `bw_ls2_process\*()` is called,
+ *    `bw_ls2_process*()` is called,
  *    `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,
  *    `1e12f`].
  *
@@ -325,8 +326,8 @@ static inline void bw_ls2_set_dc_gain_dB(
  *
  *    Valid range: [`-600.f`, `600.f`].
  *
- *    By the time `bw_ls2_reset_\*()`, `bw_ls2_update_coeffs_\*()`, or
+ *    By the time `bw_ls2_reset_*()`, `bw_ls2_update_coeffs_*()`, or
- *    `bw_ls2_process\*()` is called,
+ *    `bw_ls2_process*()` is called,
  *    `cutoff * bw_rcpf(bw_sqrtf(bw_sqrtf(dc_gain)))` must be in [`1e-6f`,
  *    `1e12f`].
  *

include/bw_osc_tri.h

@@ -1,7 +1,7 @@
 /*
  * Brickworks
  *
- * Copyright (C) 2022-2024 Orastron Srl unipersonale
+ * Copyright (C) 2022-2025 Orastron Srl unipersonale
  *
  * Brickworks is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -20,7 +20,7 @@
 
 /*!
  *  module_type {{{ dsp }}}
- *  version {{{ 1.2.0 }}}
+ *  version {{{ 1.2.1 }}}
  *  requires {{{ bw_common bw_math bw_one_pole }}}
  *  description {{{
  *    Triangle oscillator waveshaper with variable slope (increasing time over
@@ -37,6 +37,11 @@
  *  }}}
  *  changelog {{{
  *    <ul>
+ *      <li>Version <strong>1.2.1</strong>:
+ *        <ul>
+ *          <li>Fixed typo in Changelog.</li>
+ *        </ul>
+ *      </li>
  *      <li>Version <strong>1.2.0</strong>:
  *        <ul>
  *          <li>Added support for <code>BW_INCLUDE_WITH_QUOTES</code>,
@@ -85,7 +90,7 @@
  *      <li>Version <strong>0.5.0</strong>:
  *        <ul>
  *          <li>Added <code>bw_osc_tri_process_multi()</code>.</li>
- *          <li>Fixed typo in <code>bw_osc_tri_process1\*()</code>
+ *          <li>Fixed typo in <code>bw_osc_tri_process1*()</code>
  *              documentation.</li>
  *          <li>Added C++ wrapper.</li>
  *        </ul>

include/bw_peak.h

@@ -39,6 +39,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -308,8 +309,8 @@ static inline void bw_peak_set_peak_gain_lin(
  *    Valid range: [`1e-30f`, `1e30f`].
  *
  *    If actually using the bandwidth parameter to control Q, by the time
- *    `bw_peak_reset_\*()`, `bw_peak_update_coeffs_\*()`, or
+ *    `bw_peak_reset_*()`, `bw_peak_update_coeffs_*()`, or
- *    `bw_peak_process\*()` is called,
+ *    `bw_peak_process*()` is called,
  *    `bw_sqrtf(bw_pow2f(bandwidth) * peak_gain) *
  *    bw_rcpf(bw_pow2f(bandwidth) - 1.f)` must be in [`1e-6f`, `1e6f`].
  *
@@ -326,8 +327,8 @@ static inline void bw_peak_set_peak_gain_dB(
  *    Valid range: [`-600.f`, `600.f`].
  *
  *    If actually using the bandwidth parameter to control Q, by the time
- *    `bw_peak_reset_\*()`, `bw_peak_update_coeffs_\*()`, or
+ *    `bw_peak_reset_*()`, `bw_peak_update_coeffs_*()`, or
- *    `bw_peak_process\*()` is called,
+ *    `bw_peak_process*()` is called,
  *    `bw_sqrtf(bw_pow2f(bandwidth) * peak_gain) *
  *    bw_rcpf(bw_pow2f(bandwidth) - 1.f)` must be in [`1e-6f`, `1e6f`].
  *
@@ -344,8 +345,8 @@ static inline void bw_peak_set_bandwidth(
  *    Valid range: [`1e-6f`, `90.f`].
  *
  *    If actually using the bandwidth parameter to control Q, by the time
- *    `bw_peak_reset_\*()`, `bw_peak_update_coeffs_\*()`, or
+ *    `bw_peak_reset_*()`, `bw_peak_update_coeffs_*()`, or
- *    `bw_peak_process\*()` is called,
+ *    `bw_peak_process*()` is called,
  *    `bw_sqrtf(bw_pow2f(bandwidth) * peak_gain) *
  *    bw_rcpf(bw_pow2f(bandwidth) - 1.f)` must be in [`1e-6f`, `1e6f`].
  *

include/bw_phase_gen.h

@@ -33,6 +33,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -330,8 +331,8 @@ static inline void bw_phase_gen_set_phase_inc_min(
  *
  *    Valid range: [`-INFINITY`, `INFINITY`).
  *
- *    By the time `bw_phase_gen_reset_\*()`, `bw_phase_gen_update_coeffs_\*()`,
+ *    By the time `bw_phase_gen_reset_*()`, `bw_phase_gen_update_coeffs_*()`,
- *    or `bw_peak_process\*()` is called, phase_inc_min must be less than
+ *    or `bw_peak_process*()` is called, phase_inc_min must be less than
  *    phase_inc_max.
  *
  *    Default value: `-INFINITY`.
@@ -351,8 +352,8 @@ static inline void bw_phase_gen_set_phase_inc_max(
  *
  *    Valid range: (`-INFINITY`, `INFINITY`].
  *
- *    By the time `bw_phase_gen_reset_\*()`, `bw_phase_gen_update_coeffs_\*()`,
+ *    By the time `bw_phase_gen_reset_*()`, `bw_phase_gen_update_coeffs_*()`,
- *    or `bw_peak_process\*()` is called, phase_inc_min must be less than
+ *    or `bw_peak_process*()` is called, phase_inc_min must be less than
  *    phase_inc_max.
  *
  *    Default value: `INFINITY`.

include/bw_phaser.h

@@ -34,6 +34,7 @@
  *        <ul>
  *          <li>Now using <code>BW_NULL</code> in the C++ API and
  *              implementation.</li>
+ *          <li>Fixed typos in documenation.</li>
  *        </ul>
  *      </li>
  *      <li>Version <strong>1.2.0</strong>:
@@ -254,8 +255,8 @@ static inline void bw_phaser_set_center(
  *
  *    Valid range: [`1e-6f`, `1e12f`].
  *
- *    By the time `bw_phaser_reset_\*()`, `bw_phaser_update_coeffs_\*()`, or
+ *    By the time `bw_phaser_reset_*()`, `bw_phaser_update_coeffs_*()`, or
- *    `bw_phaser_process\*()` is called, `center * bw_pow2f(amount)` must be in
+ *    `bw_phaser_process*()` is called, `center * bw_pow2f(amount)` must be in
  *    [`1e-6f`, `1e12f`].
  *
  *    Default value: `1e3f`.
@@ -270,8 +271,8 @@ static inline void bw_phaser_set_amount(
  *
  *    `value` must be finite and non-negative.
  *
- *    By the time `bw_phaser_reset_\*()`, `bw_phaser_update_coeffs_\*()`, or
+ *    By the time `bw_phaser_reset_*()`, `bw_phaser_update_coeffs_*()`, or
- *    `bw_phaser_process\*()` is called, `center * bw_pow2f(amount)` must be in
+ *    `bw_phaser_process*()` is called, `center * bw_pow2f(amount)` must be in
  *    [`1e-6f`, `1e12f`].
  *
  *    Default value: `1.f`.