capture: add doc for new_from_fd

This commit is contained in:
Christian Hergert
2018-05-17 13:13:36 +01:00
parent 1ef68eeb31
commit 7f889b487d

View File

@ -106,6 +106,17 @@ sp_capture_reader_get_filename (SpCaptureReader *self)
return self->filename;
}
/**
* sp_capture_reader_new_from_fd:
* @fd: an fd to take ownership from
* @error: a location for a #GError or %NULL
*
* Creates a new reader using the file-descriptor.
*
* This is useful if you don't necessarily have access to the filename itself.
*
* Returns: (transfer full): an #SpCaptureReader or %NULL upon failure.
*/
SpCaptureReader *
sp_capture_reader_new_from_fd (int fd,
GError **error)