From f623002c27637909bf6540fa453f722f96e8c0c0 Mon Sep 17 00:00:00 2001
From: Stefano D'Angelo <stefano.dangelo@orastron.com>
Date: Mon, 1 Jul 2024 19:30:42 +0200
Subject: [PATCH] bw_phase_gen: bw_phase_get_set_phase_inc_{min,max} doc

---
 include/bw_phase_gen.h | 39 ++++++++++++++++++++++++++++++++++++---
 1 file changed, 36 insertions(+), 3 deletions(-)

diff --git a/include/bw_phase_gen.h b/include/bw_phase_gen.h
index c40205f..f0852b5 100644
--- a/include/bw_phase_gen.h
+++ b/include/bw_phase_gen.h
@@ -296,15 +296,48 @@ static inline void bw_phase_gen_set_portamento_tau(
  *
  *    Default value: `0.f`.
  *
- * XXX (also remember very small inc)
- */
+ *    #### bw_phase_gen_set_phase_inc_min()
+ *  ```>>> */
 static inline void bw_phase_gen_set_phase_inc_min(
 	bw_phase_gen_coeffs * BW_RESTRICT coeffs,
 	float                             value);
+/*! <<<```
+ *    Sets the minimum phase increment `value` in `coeffs`.
+ *
+ *    The algorithm will limit the actual phase increment accordingly, yet if
+ *    the magnitude of the resulting phase increment is less than `6e-8f`, it
+ *    will be rounded to `0.f` and such value will be reported by processing
+ *    functions.
+ *
+ *    Valid range: [`-INFINITY`, `INFINITY`).
+ *
+ *    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
+ *    phase_inc_max.
+ *
+ *    Default value: `-INFINITY`.
+ *
+ *    #### bw_phase_gen_set_phase_inc_max()
+ *  ```>>> */
 static inline void bw_phase_gen_set_phase_inc_max(
 	bw_phase_gen_coeffs * BW_RESTRICT coeffs,
 	float                             value);
-/*
+/*! <<<```
+ *    Sets the maximum phase increment `value` in `coeffs`.
+ *
+ *    The algorithm will limit the actual phase increment accordingly, yet if
+ *    the magnitude of the resulting phase increment is less than `6e-8f`, it
+ *    will be rounded to `0.f` and such value will be reported by processing
+ *    functions.
+ *
+ *    Valid range: (`-INFINITY`, `INFINITY`].
+ *
+ *    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
+ *    phase_inc_max.
+ *
+ *    Default value: `INFINITY`.
+ *
  *    #### bw_phase_gen_coeffs_is_valid()
  *  ```>>> */
 static inline char bw_phase_gen_coeffs_is_valid(