From 93a037efff7b8afd04aad76f6b6a4514acb6f670 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Tue, 8 Jan 2019 16:43:50 +0200 Subject: libcamera: Document missing parameters and return values MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Several functions are missing documentation for some of them parameters and/or for their return value. Fix this. Signed-off-by: Laurent Pinchart Reviewed-by: Niklas Söderlund --- src/libcamera/device_enumerator.cpp | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src/libcamera/device_enumerator.cpp') diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp index c088f3e5..f1d016db 100644 --- a/src/libcamera/device_enumerator.cpp +++ b/src/libcamera/device_enumerator.cpp @@ -124,6 +124,9 @@ bool DeviceMatch::match(const MediaDevice *device) const * implementations may be needed. This function creates the best enumerator for * the operating system based on the available resources. Not all different * enumerator types are guaranteed to support all features. + * + * \return A pointer to the newly created device enumerator on success, or + * nullptr if an error occurs */ DeviceEnumerator *DeviceEnumerator::create() { -- cgit v1.2.1