Actually faff documentation

xmos · Feb 8, 2024 · ea89db5 · ea89db5
1 parent 5effefa
commit ea89db5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/doc/programming_guide/reference/i2s/i2s_common.rst b/doc/programming_guide/reference/i2s/i2s_common.rst
@@ -6,6 +6,12 @@
 |I2S| Instances
 ===============
 
+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.
+
 The following structures and functions are used by an |I2S| master or slave instance.
 
 .. doxygengroup:: hil_i2s_core

diff --git a/modules/i2s/api/i2s.h b/modules/i2s/api/i2s.h
@@ -15,12 +15,6 @@
  * 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.
  */
 
 #define I2S_MAX_DATALINES 8