diff options
author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-01-08 16:43:50 +0200 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-01-10 15:27:59 +0200 |
commit | 93a037efff7b8afd04aad76f6b6a4514acb6f670 (patch) | |
tree | 6608b056c53e07baacee78e5ed8bf772a5026afc /src/libcamera/device_enumerator.cpp | |
parent | afcec99b99c3313805deaededa3158e4ad089b6e (diff) |
libcamera: Document missing parameters and return values
Several functions are missing documentation for some of them parameters
and/or for their return value. Fix this.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Diffstat (limited to 'src/libcamera/device_enumerator.cpp')
-rw-r--r-- | src/libcamera/device_enumerator.cpp | 3 |
1 files changed, 3 insertions, 0 deletions
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() { |