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

fix doc typos in bw_slew_lim

Browse Source
This commit is contained in:
Stefano D'Angelo 2025-03-21 16:17:27 +01:00
parent 97790bc330
commit 5f494781ac
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/bw_slew_lim.h
View File

@ -20,13 +20,20 @@
/*! /*!
* module_type {{{ dsp }}} * module_type {{{ dsp }}}
* version {{{ 1.2.1 }}} * version {{{ 1.2.2 }}}
* requires {{{ bw_common bw_math }}} * requires {{{ bw_common bw_math }}}
* description {{{ * description {{{
* Slew-rate limiter with separate maximum increasing and decreasing rates. * Slew-rate limiter with separate maximum increasing and decreasing rates.
* }}} * }}}
* changelog {{{ * changelog {{{
* <ul> * <ul>
* <li>Version <strong>1.2.2</strong>:
* <ul>
* <li>Fixed typos in the documentation of
* <code>bw_slew_lim_set_max_rate()</code> and
* <code>bw_slew_lim_set_max_rate_down()</code>.</li>
* </ul>
* </li>
* <li>Version <strong>1.2.1</strong>: * <li>Version <strong>1.2.1</strong>:
* <ul> * <ul>
* <li>Now using <code>BW_NULL</code> in the C++ API and * <li>Now using <code>BW_NULL</code> in the C++ API and
@ -281,8 +288,8 @@ static inline void bw_slew_lim_set_max_rate(
* `value` represents the maximum variation per second and must be * `value` represents the maximum variation per second and must be
* non-negative. * non-negative.
* *
* This is equivalent to calling both `bw_slew_lim_set_max_inc_rate()` and * This is equivalent to calling both `bw_slew_lim_set_max_rate_up()` and
* `bw_slew_lim_set_max_dec_rate()` with same `coeffs` and `value`. * `bw_slew_lim_set_max_rate_down()` with same `coeffs` and `value`.
* *
* Default value: `INFINITY`. * Default value: `INFINITY`.
* >>> */ * >>> */
@ -304,7 +311,7 @@ static inline void bw_slew_lim_set_max_rate_up(
* >>> */ * >>> */
/*! ... /*! ...
* #### bw_slew_lim_set_max_inc_rate() * #### bw_slew_lim_set_max_rate_up()
* ```>>> */ * ```>>> */
static inline void bw_slew_lim_set_max_rate_down( static inline void bw_slew_lim_set_max_rate_down(
bw_slew_lim_coeffs * BW_RESTRICT coeffs, bw_slew_lim_coeffs * BW_RESTRICT coeffs,