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

fixed doc typos

Browse Source
This commit is contained in:
Stefano D'Angelo 2023-05-29 10:13:13 +02:00
parent 60ca76b9a3
commit 47cdfb4ee1
2 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/bw_comp.h
View File

@ -1,7 +1,7 @@
/* /*
* Brickworks * 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 * Brickworks is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -20,7 +20,7 @@
/*! /*!
* module_type {{{ dsp }}} * module_type {{{ dsp }}}
* version {{{ 0.3.0 }}} * version {{{ 0.5.0 }}}
* requires {{{ * requires {{{
* bw_config bw_common bw_env_follow bw_one_pole bw_math bw_gain * bw_config bw_common bw_env_follow bw_one_pole bw_math bw_gain
* }}} * }}}
@ -29,6 +29,12 @@
* }}} * }}}
* changelog {{{ * changelog {{{
* <ul> * <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>: * <li>Version <strong>0.3.0</strong>:
* <ul> * <ul>
* <li>First release.</li> * <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); 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, * `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. * hence `1.f` means no compression and `0.f` is a hard limit.

10
include/bw_osc_tri.h
View File

@ -20,7 +20,7 @@
/*! /*!
* module_type {{{ dsp }}} * module_type {{{ dsp }}}
* version {{{ 0.4.0 }}} * version {{{ 0.5.0 }}}
* requires {{{ bw_config bw_common bw_one_pole bw_math }}} * requires {{{ bw_config bw_common bw_one_pole bw_math }}}
* description {{{ * description {{{
* Triangle oscillator waveshaper with variable slope (increasing time over * Triangle oscillator waveshaper with variable slope (increasing time over
@ -31,6 +31,12 @@
* }}} * }}}
* changelog {{{ * changelog {{{
* <ul> * <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>: * <li>Version <strong>0.4.0</strong>:
* <ul> * <ul>
* <li>Fixed unused parameter warnings.</li> * <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`. * 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(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); static inline float bw_osc_tri_process1_antialias(const bw_osc_tri_coeffs *BW_RESTRICT coeffs, float x, float x_phase_inc);