From 7f889b487da51cb052f947e9030a9067f811bdd3 Mon Sep 17 00:00:00 2001 From: Christian Hergert Date: Thu, 17 May 2018 13:13:36 +0100 Subject: [PATCH] capture: add doc for new_from_fd --- lib/capture/sp-capture-reader.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/lib/capture/sp-capture-reader.c b/lib/capture/sp-capture-reader.c index df331747..5ea528d3 100644 --- a/lib/capture/sp-capture-reader.c +++ b/lib/capture/sp-capture-reader.c @@ -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)