Skip to content

Commit

Permalink
Added docstring for new macro
Browse files Browse the repository at this point in the history
  • Loading branch information
ACascarino committed Feb 8, 2024
1 parent 458a673 commit 376bd40
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions modules/i2s/api/i2s.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@
* \addtogroup hil_i2s_core hil_i2s_core
*
* The public API for using the HIL I2S core.
*
* The macro I2S_DATA_WIDTH may be set as a compile flag (e.g.
* -DI2S_DATA_WIDTH=16) to alter the number of bits per word for both the I2S
* Master and I2S Slave components; this defaults to 32 bits per word. This
* value may be set to any value between 1 and 32. Correct operation of the I2S
* components has only currently been verified at 16 and 32 bits per word.
*
* @{
*/

Expand Down

0 comments on commit 376bd40

Please sign in to comment.