fix typo in bw_note_queue + cosmetics

2024-10-02 11:30:32 +02:00 · 2024-10-02 11:30:32 +02:00 · dd6f6adb2c
commit dd6f6adb2c
parent c7f930673f
49 changed files with 99 additions and 1 deletions
--- a/include/bw_ap2.h
+++ b/include/bw_ap2.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_ap2_coeffs
 *  ```>>> */
--- a/include/bw_balance.h
+++ b/include/bw_balance.h
@ -97,6 +97,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_balance_coeffs
 *  ```>>> */
--- a/include/bw_bd_reduce.h
+++ b/include/bw_bd_reduce.h
@ -106,6 +106,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_bd_reduce_coeffs
 *  ```>>> */
--- a/include/bw_cab.h
+++ b/include/bw_cab.h
@ -64,6 +64,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_cab_coeffs
 *  ```>>> */
--- a/include/bw_chorus.h
+++ b/include/bw_chorus.h
@ -114,6 +114,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_chorus_coeffs
 *  ```>>> */
--- a/include/bw_clip.h
+++ b/include/bw_clip.h
@ -114,6 +114,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_clip_coeffs
 *  ```>>> */
--- a/include/bw_comb.h
+++ b/include/bw_comb.h
@ -115,6 +115,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_comb_coeffs
 *  ```>>> */
--- a/include/bw_comp.h
+++ b/include/bw_comp.h
@ -116,6 +116,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_comp_coeffs
 *  ```>>> */
--- a/include/bw_delay.h
+++ b/include/bw_delay.h
@ -110,6 +110,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_delay_coeffs
 *  ```>>> */
--- a/include/bw_dist.h
+++ b/include/bw_dist.h
@ -101,6 +101,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_dist_coeffs
 *  ```>>> */
--- a/include/bw_drive.h
+++ b/include/bw_drive.h
@ -102,6 +102,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_drive_coeffs
 *  ```>>> */
--- a/include/bw_dry_wet.h
+++ b/include/bw_dry_wet.h
@ -92,6 +92,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_dry_wet_coeffs
 *  ```>>> */
--- a/include/bw_env_follow.h
+++ b/include/bw_env_follow.h
@ -113,6 +113,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_env_follow_coeffs
 *  ```>>> */
--- a/include/bw_env_gen.h
+++ b/include/bw_env_gen.h
@ -146,6 +146,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_env_gen_coeffs
 *  ```>>> */
--- a/include/bw_fuzz.h
+++ b/include/bw_fuzz.h
@ -102,6 +102,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_fuzz_coeffs
 *  ```>>> */
--- a/include/bw_gain.h
+++ b/include/bw_gain.h
@ -112,6 +112,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_gain_coeffs
 *  ```>>> */
--- a/include/bw_hp1.h
+++ b/include/bw_hp1.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_hp1_coeffs
 *  ```>>> */
--- a/include/bw_hs1.h
+++ b/include/bw_hs1.h
@ -111,6 +111,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_hs1_coeffs
 *  ```>>> */
--- a/include/bw_hs2.h
+++ b/include/bw_hs2.h
@ -115,6 +115,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_hs2_coeffs
 *  ```>>> */
--- a/include/bw_lp1.h
+++ b/include/bw_lp1.h
@ -108,6 +108,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_lp1_coeffs
 *  ```>>> */
--- a/include/bw_ls1.h
+++ b/include/bw_ls1.h
@ -112,6 +112,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_ls1_coeffs
 *  ```>>> */
--- a/include/bw_ls2.h
+++ b/include/bw_ls2.h
@ -120,6 +120,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_ls2_coeffs
 *  ```>>> */
--- a/include/bw_mm1.h
+++ b/include/bw_mm1.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_mm1_coeffs
 *  ```>>> */
--- a/include/bw_mm2.h
+++ b/include/bw_mm2.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_mm2_coeffs
 *  ```>>> */
--- a/include/bw_noise_gate.h
+++ b/include/bw_noise_gate.h
@ -113,6 +113,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_noise_gate_coeffs
 *  ```>>> */
--- a/include/bw_noise_gen.h
+++ b/include/bw_noise_gen.h
@ -98,6 +98,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_noise_gen_coeffs
 *  ```>>> */
--- a/include/bw_notch.h
+++ b/include/bw_notch.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_notch_coeffs
 *  ```>>> */
--- a/include/bw_note_queue.h
+++ b/include/bw_note_queue.h
@ -35,6 +35,8 @@
 *          <li>Added support for <code>BW_INCLUDE_WITH_QUOTES</code>,
 *              <code>BW_NO_CXX</code>, and
 *              <code>BW_CXX_NO_EXTERN_C</code>.</li>
+ *          <li>Fixed typo in the documentation of
+ *              <code>bw_note_queue_reset()</code>.</li>
 *        </ul>
 *      </li>
 *      <li>Version <strong>1.0.1</strong>:
@ -134,7 +136,7 @@ typedef struct {
 static inline void bw_note_queue_reset(
 	bw_note_queue * BW_RESTRICT queue);
 /*! <<<```
- *    Clear both the event queue (no events) and the note statuses (all notes
+ *    Clears both the event queue (no events) and the note statuses (all notes
 *    off, all velocities `0.f`) in `queue`.
 *
 *    #### bw_note_queue_clear()
--- a/include/bw_osc_filt.h
+++ b/include/bw_osc_filt.h
@ -111,6 +111,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_osc_filt_state
 *  ```>>> */
--- a/include/bw_osc_pulse.h
+++ b/include/bw_osc_pulse.h
@ -120,6 +120,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_osc_pulse_coeffs
 *  ```>>> */
--- a/include/bw_osc_saw.h
+++ b/include/bw_osc_saw.h
@ -119,6 +119,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_osc_saw_coeffs
 *  ```>>> */
--- a/include/bw_osc_sin.h
+++ b/include/bw_osc_sin.h
@ -100,6 +100,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_osc_sin_process1()
 *  ```>>> */
--- a/include/bw_osc_tri.h
+++ b/include/bw_osc_tri.h
@ -122,6 +122,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_osc_tri_coeffs
 *  ```>>> */
--- a/include/bw_pan.h
+++ b/include/bw_pan.h
@ -96,6 +96,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_pan_coeffs
 *  ```>>> */
--- a/include/bw_peak.h
+++ b/include/bw_peak.h
@ -123,6 +123,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_peak_coeffs
 *  ```>>> */
--- a/include/bw_phase_gen.h
+++ b/include/bw_phase_gen.h
@ -134,6 +134,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_phase_gen_coeffs
 *  ```>>> */
--- a/include/bw_phaser.h
+++ b/include/bw_phaser.h
@ -109,6 +109,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_phaser_coeffs
 *  ```>>> */
--- a/include/bw_pink_filt.h
+++ b/include/bw_pink_filt.h
@ -135,6 +135,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_pink_filt_coeffs
 *  ```>>> */
--- a/include/bw_ppm.h
+++ b/include/bw_ppm.h
@ -105,6 +105,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_ppm_coeffs
 *  ```>>> */
--- a/include/bw_reverb.h
+++ b/include/bw_reverb.h
@ -107,6 +107,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_reverb_coeffs
 *  ```>>> */
--- a/include/bw_ring_mod.h
+++ b/include/bw_ring_mod.h
@ -98,6 +98,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_ring_mod_coeffs
 *  ```>>> */
--- a/include/bw_satur.h
+++ b/include/bw_satur.h
@ -128,6 +128,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_satur_coeffs
 *  ```>>> */
--- a/include/bw_slew_lim.h
+++ b/include/bw_slew_lim.h
@ -112,6 +112,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_slew_lim_coeffs
 *  ```>>> */
--- a/include/bw_sr_reduce.h
+++ b/include/bw_sr_reduce.h
@ -114,6 +114,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_sr_reduce_coeffs
 *  ```>>> */
--- a/include/bw_src.h
+++ b/include/bw_src.h
@ -96,6 +96,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_src_coeffs
 *  ```>>> */
--- a/include/bw_src_int.h
+++ b/include/bw_src_int.h
@ -102,6 +102,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_src_int_coeffs
 *  ```>>> */
--- a/include/bw_svf.h
+++ b/include/bw_svf.h
@ -128,6 +128,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_svf_coeffs
 *  ```>>> */
--- a/include/bw_trem.h
+++ b/include/bw_trem.h
@ -103,6 +103,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_trem_coeffs
 *  ```>>> */
--- a/include/bw_wah.h
+++ b/include/bw_wah.h
@ -117,6 +117,8 @@
 extern "C" {
 #endif

+/*** Public API ***/
+
 /*! api {{{
 *    #### bw_wah_coeffs
 *  ```>>> */