Project

General

Profile

Bug #3590

Key Functions Missing Documentation

Added by xloem about 2 months ago.

Status:
New
Priority:
Normal
Assignee:
-
Target version:
-
Start date:
09/25/2018
Due date:
% Done:

0%


Description

A few of the functions in rtl-sdr.h have no documentation.

Personally, I have repeatedly called rtlsdr_read_sync to produce a stream of data in the past, but after inspecting the source and doing some testing I've learned that this data would have been corrupt, because of the time spent with no buffers in flight. I'd like to add documentation to this function indicating it is not appropriate for streaming, and it would make sense to document the other empty ones too.

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)