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>

1 files changed, 5 insertions, 3 deletions

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 093821d4..ee769487 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -36,11 +36,13 @@ namespace libcamera {
 /**
  * \fn PipelineHandler::match(DeviceEnumerator *enumerator)
  * \brief Match media devices and create camera instances
+ * \param enumerator The enumerator providing all media devices found in the
+ * system
  *
  * This function is the main entry point of the pipeline handler. It is called
- * by the device enumerator with the enumerator passed as an argument. It shall
- * acquire from the enumerator all the media devices it needs for a single
- * pipeline and create one or multiple Camera instances.
+ * by the device enumerator with the \a enumerator passed as an argument. It
+ * shall acquire from the \a enumerator all the media devices it needs for a
+ * single pipeline and create one or multiple Camera instances.
  *
  * If all media devices needed by the pipeline handler are found, they must all
  * be acquired by a call to MediaDevice::acquire(). This function shall then