Commit 7c91f3c
authored
docs: Add missing read() method documentation to I2S library
Fixes #2583
Added comprehensive documentation for the read() method in the I2S library.
The read() method was being used in examples but was not documented in the API reference. This commit adds:
- Method description
- Two syntax variants (single sample and buffer read)
- Parameter documentation
- Return value documentation
This resolves the issue where users could not find documentation for the read() method despite it being used in code examples.1 parent f42b67d commit 7c91f3c
1 file changed
+30
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
110 | 110 | | |
111 | 111 | | |
112 | 112 | | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
113 | 143 | | |
114 | 144 | | |
115 | 145 | | |
| |||
0 commit comments