fix(Documentation): Fix Inaccurate SPI Threshold Docstrings (#1096)

analogdevicesinc · Aug 27, 2024 · 428abd6 · 428abd6
1 parent 3fa3d21
commit 428abd6
Show file tree

Hide file tree

Showing 16 changed files with 32 additions and 32 deletions.
diff --git a/Libraries/PeriphDrivers/Include/MAX32520/spi.h b/Libraries/PeriphDrivers/Include/MAX32520/spi.h
@@ -405,7 +405,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -433,7 +433,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32570/spi.h b/Libraries/PeriphDrivers/Include/MAX32570/spi.h
@@ -412,7 +412,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -440,7 +440,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32572/spi.h b/Libraries/PeriphDrivers/Include/MAX32572/spi.h
@@ -550,7 +550,7 @@ void MXC_SPI_ClearRXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -569,7 +569,7 @@ int MXC_SPI_SetTXThreshold(mxc_spi_regs_t *spi, unsigned int numBytes);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32650/spi.h b/Libraries/PeriphDrivers/Include/MAX32650/spi.h
@@ -415,7 +415,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -443,7 +443,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32655/spi.h b/Libraries/PeriphDrivers/Include/MAX32655/spi.h
@@ -457,7 +457,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -485,7 +485,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32657/spi.h b/Libraries/PeriphDrivers/Include/MAX32657/spi.h
@@ -456,7 +456,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -484,7 +484,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32660/spi.h b/Libraries/PeriphDrivers/Include/MAX32660/spi.h
@@ -411,7 +411,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -439,7 +439,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32662/spi.h b/Libraries/PeriphDrivers/Include/MAX32662/spi.h
@@ -435,7 +435,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -463,7 +463,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32665/spi.h b/Libraries/PeriphDrivers/Include/MAX32665/spi.h
@@ -413,7 +413,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -441,7 +441,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32670/spi.h b/Libraries/PeriphDrivers/Include/MAX32670/spi.h
@@ -411,7 +411,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -439,7 +439,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32672/spi.h b/Libraries/PeriphDrivers/Include/MAX32672/spi.h
@@ -410,7 +410,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -438,7 +438,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32675/spi.h b/Libraries/PeriphDrivers/Include/MAX32675/spi.h
@@ -410,7 +410,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -438,7 +438,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32680/spi.h b/Libraries/PeriphDrivers/Include/MAX32680/spi.h
@@ -433,7 +433,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -461,7 +461,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX32690/spi.h b/Libraries/PeriphDrivers/Include/MAX32690/spi.h
@@ -548,7 +548,7 @@ void MXC_SPI_ClearRXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -567,7 +567,7 @@ int MXC_SPI_SetTXThreshold(mxc_spi_regs_t *spi, unsigned int numBytes);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX78000/spi.h b/Libraries/PeriphDrivers/Include/MAX78000/spi.h
@@ -428,7 +428,7 @@ void MXC_SPI_ClearTXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -456,7 +456,7 @@ unsigned int MXC_SPI_GetRXThreshold(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI registers (selects the SPI block used.)
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */

diff --git a/Libraries/PeriphDrivers/Include/MAX78002/spi.h b/Libraries/PeriphDrivers/Include/MAX78002/spi.h
@@ -549,7 +549,7 @@ void MXC_SPI_ClearRXFIFO(mxc_spi_regs_t *spi);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set.  This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */
@@ -568,7 +568,7 @@ int MXC_SPI_SetTXThreshold(mxc_spi_regs_t *spi, unsigned int numBytes);
  *
  * @param   spi         Pointer to SPI instance's registers.
  * @param   numBytes    The threshold level to set. This value must be
- *                      between 0 and 8 inclusive.
+ *                      between 0 and 30 inclusive.
  *
  * @return  Success/Fail, see \ref MXC_Error_Codes for a list of return codes.
  */