Skip to content

Commit efa57bf

Browse files
committedFeb 23, 2025
Minor fix to the doxygen text for setupStream
1 parent d8cdc10 commit efa57bf

File tree

2 files changed

+13
-15
lines changed

2 files changed

+13
-15
lines changed
 

‎include/SoapySDR/Device.h

+10-12
Original file line numberDiff line numberDiff line change
@@ -265,15 +265,8 @@ SOAPY_SDR_API SoapySDRArgInfo *SoapySDRDevice_getStreamArgsInfo(const SoapySDRDe
265265
* the same sample rate. See SoapySDRDevice_setSampleRate().
266266
*
267267
* \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-
*
275268
* \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()`.
277270
* \parblock
278271
*
279272
* The first character selects the number type:
@@ -295,13 +288,18 @@ SOAPY_SDR_API SoapySDRArgInfo *SoapySDRDevice_getStreamArgsInfo(const SoapySDRDe
295288
* \endparblock
296289
* \param channels a list of channels or empty for automatic
297290
* \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.
299292
* \parblock
300293
*
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.
303302
* \endparblock
304-
* \return the stream pointer or nullptr for failure
305303
*/
306304
SOAPY_SDR_API SoapySDRStream *SoapySDRDevice_setupStream(SoapySDRDevice *device,
307305
const int direction,

‎include/SoapySDR/Device.hpp

+3-3
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ class SOAPY_SDR_API Device
230230
* the same sample rate. See setSampleRate().
231231
*
232232
* \param direction the channel direction (`SOAPY_SDR_RX` or `SOAPY_SDR_TX`)
233-
* \param format A string representing the desired buffer format in read/writeStream()
233+
* \param format A string representing the desired buffer format in `readStream()` / `writeStream()`.
234234
* \parblock
235235
*
236236
* The first character selects the number type:
@@ -254,8 +254,8 @@ class SOAPY_SDR_API Device
254254
* \param args stream args or empty for defaults.
255255
* \parblock
256256
*
257-
* Recommended keys to use in the args dictionary:
258-
* - "WIRE" - format of the samples between device and host
257+
* Recommended keys to use in the args dictionary:
258+
* - "WIRE" - format of the samples between device and host
259259
* \endparblock
260260
* \return an opaque pointer to a stream handle.
261261
* \parblock

0 commit comments

Comments
 (0)