From 47cdfb4ee1649fd403fee0063d74e56c352c2ed2 Mon Sep 17 00:00:00 2001
From: Stefano D'Angelo <stefano.dangelo@orastron.com>
Date: Mon, 29 May 2023 10:13:13 +0200
Subject: [PATCH] fixed doc typos

---
 include/bw_comp.h    | 12 +++++++++---
 include/bw_osc_tri.h | 10 ++++++++--
 2 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/include/bw_comp.h b/include/bw_comp.h
index c6f6cf2..b14263f 100644
--- a/include/bw_comp.h
+++ b/include/bw_comp.h
@@ -1,7 +1,7 @@
 /*
  * Brickworks
  *
- * Copyright (C) 2022 Orastron Srl unipersonale
+ * Copyright (C) 2022, 2023 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 {{{ 0.3.0 }}}
+ *  version {{{ 0.5.0 }}}
  *  requires {{{
  *    bw_config bw_common bw_env_follow bw_one_pole bw_math bw_gain
  *  }}}
@@ -29,6 +29,12 @@
  *  }}}
  *  changelog {{{
  *    <ul>
+ *      <li>Version <strong>0.5.0</strong>:
+ *        <ul>
+ *          <li>Fixed typo in <code>bw_comp_set_ratio()</code>
+ *              documentation.</li>
+ *        </ul>
+ *      </li>
  *      <li>Version <strong>0.3.0</strong>:
  *        <ul>
  *          <li>First release.</li>
@@ -133,7 +139,7 @@ static inline void bw_comp_set_thresh_dBFS(bw_comp_coeffs *BW_RESTRICT coeffs, f
  *  ```>>> */
 static inline void bw_comp_set_ratio(bw_comp_coeffs *BW_RESTRICT coeffs, float value);
 /*! <<<```
- *    Sets the copmpression ratio `value` in `coeffs`.
+ *    Sets the compression ratio `value` in `coeffs`.
  *
  *    `value` is actually the slope of the gain curve above the threshold,
  *    hence `1.f` means no compression and `0.f` is a hard limit.
diff --git a/include/bw_osc_tri.h b/include/bw_osc_tri.h
index ae42dca..96d5f1d 100644
--- a/include/bw_osc_tri.h
+++ b/include/bw_osc_tri.h
@@ -20,7 +20,7 @@
 
 /*!
  *  module_type {{{ dsp }}}
- *  version {{{ 0.4.0 }}}
+ *  version {{{ 0.5.0 }}}
  *  requires {{{ bw_config bw_common bw_one_pole bw_math }}}
  *  description {{{
  *    Triangle oscillator waveshaper with variable slope (increasing time over
@@ -31,6 +31,12 @@
  *  }}}
  *  changelog {{{
  *    <ul>
+ *      <li>Version <strong>0.5.0</strong>:
+ *        <ul>
+ *          <li>Fixed typo in <code>bw_osc_tri_process1\*()</code>
+ *              documentation.</li>
+ *        </ul>
+ *      </li>
  *      <li>Version <strong>0.4.0</strong>:
  *        <ul>
  *          <li>Fixed unused parameter warnings.</li>
@@ -96,7 +102,7 @@ static inline void bw_osc_tri_update_coeffs_audio(bw_osc_tri_coeffs *BW_RESTRICT
 /*! <<<```
  *    Triggers audio-rate update of coefficients in `coeffs`.
  *
- *    #### bw_osc_pulse_process1\*()
+ *    #### bw_osc_tri_process1\*()
  *  ```>>> */
 static inline float bw_osc_tri_process1(const bw_osc_tri_coeffs *BW_RESTRICT coeffs, float x);
 static inline float bw_osc_tri_process1_antialias(const bw_osc_tri_coeffs *BW_RESTRICT coeffs, float x, float x_phase_inc);