@@ -265,15 +265,8 @@ SOAPY_SDR_API SoapySDRArgInfo *SoapySDRDevice_getStreamArgsInfo(const SoapySDRDe
265
265
* the same sample rate. See SoapySDRDevice_setSampleRate().
266
266
*
267
267
* \param device a pointer to a device instance
268
- * \return the opaque pointer to a stream handle.
269
- * \parblock
270
- *
271
- * The returned stream is not required to have internal locking, and may not be used
272
- * concurrently from multiple threads.
273
- * \endparblock
274
- *
275
268
* \param direction the channel direction (`SOAPY_SDR_RX` or `SOAPY_SDR_TX`)
276
- * \param format A string representing the desired buffer format in read/ writeStream()
269
+ * \param format A string representing the desired buffer format in `readStream()` / ` writeStream()`.
277
270
* \parblock
278
271
*
279
272
* The first character selects the number type:
@@ -295,13 +288,18 @@ SOAPY_SDR_API SoapySDRArgInfo *SoapySDRDevice_getStreamArgsInfo(const SoapySDRDe
295
288
* \endparblock
296
289
* \param channels a list of channels or empty for automatic
297
290
* \param numChans the number of elements in the channels array
298
- * \param args stream args or empty for defaults
291
+ * \param args stream args or empty for defaults.
299
292
* \parblock
300
293
*
301
- * Recommended keys to use in the args dictionary:
302
- * - "WIRE" - format of the samples between device and host
294
+ * Recommended keys to use in the args dictionary:
295
+ * - "WIRE" - format of the samples between device and host
296
+ * \endparblock
297
+ * \return the stream pointer or nullptr for failure.
298
+ * \parblock
299
+ *
300
+ * The returned stream is not required to have internal locking, and may not be used
301
+ * concurrently from multiple threads.
303
302
* \endparblock
304
- * \return the stream pointer or nullptr for failure
305
303
*/
306
304
SOAPY_SDR_API SoapySDRStream * SoapySDRDevice_setupStream (SoapySDRDevice * device ,
307
305
const int direction ,
0 commit comments