Update some doxygen comments in LimeSuite.h
@@ -893,8 +893,8 @@ API_EXPORT int CALL_CONV LMS_ReadCustomBoardParam(lms_device_t *device,
*
* @param device Device handle previously obtained by LMS_Open().
* @param id Parameter identifier (\ref BOARD_PARAM)
- * @param val Value to write
- * @param units [optional] measurement units of parameter if available
+ * @param[out] val Value to write
+ * @param[out] units [optional] measurement units of parameter if available
*
* @return 0 on success, (-1) on failure
*/
@@ -1098,19 +1098,19 @@ typedef struct
bool active;
///Number of samples in FIFO buffer
uint32_t fifoFilledCount;
- ///Size of FIFO buffer
+ ///Size (in samples) of FIFO buffer
uint32_t fifoSize;
- ///FIFO underrun count
+ ///FIFO underrun count since last call to LMS_GetStreamStatus()
uint32_t underrun;
- ///FIFO overrun count
+ ///FIFO overrun count since last call to LMS_GetStreamStatus()
uint32_t overrun;
- ///Number of dropped packets by HW
+ ///Number of dropped packets by HW since last call to LMS_GetStreamStatus()
uint32_t droppedPackets;
///Currently not used
float_type sampleRate;
- ///Combined data rate of all stream of the same direction (TX or RX)
+ ///Data transfer rate from board per direction per LMS chip.
float_type linkRate;
- ///Current HW timestamp
+ ///The most recently received Rx timestamp, or the last timestamp submitted to Tx.
uint64_t timestamp;
} lms_stream_status_t;
