Merge pull request #79 from uvvpavel/feature/vpu_voice_doc_update

refreshing vpu_voice API documentation

Author: uvvpavel

lib_src/src/fixed_factor_vpu_voice/src_poly.h

@@ -38,6 +38,7 @@ static inline void src_ff3_72t_ds(int32_t samp_in[3], int32_t samp_out[1], const
  * @param samp_out      Upsampled output
  * @param coefs_ff3     Three-phase FIR coefficients array with [3][24] dimentions
  * @param state_ds      FIR state array with 24 elements in it
+ * @note samp_in and samp_out have to be different memory locations
  */
 static inline void src_ff3_72t_us(int32_t samp_in[1], int32_t samp_out[3], const int32_t coefs_ff3[3][24], int32_t state_us[24])
 {
@@ -88,6 +89,7 @@ static inline void src_ff3_96t_ds(int32_t samp_in[3], int32_t samp_out[1], const
  * @param samp_out      Upsampled output
  * @param coefs_ff3     Three-phase FIR coefficients array with [3][32] dimentions
  * @param state_ds      FIR state array with 32 elements in it
+ * @note samp_in and samp_out have to be different memory locations
  */
 static inline void src_ff3_96t_us(int32_t samp_in[1], int32_t samp_out[3], const int32_t coefs_ff3[3][32], int32_t state_us[32])
 {
@@ -138,6 +140,7 @@ static inline void src_rat_2_3_96t_ds(int32_t samp_in[3], int32_t samp_out[2], c
  * @param samp_out      Upsampled output
  * @param coefs_ff3     Three-phase FIR coefficients array with [3][32] dimentions
  * @param state_ds      FIR state array with 32 lements in it
+ * @note samp_in and samp_out have to be different memory locations
  */
 static inline void src_rat_3_2_96t_us(int32_t samp_in[2], int32_t samp_out[3], const int32_t coefs_us[3][32], int32_t state_us[32])
 {