diff options
| author | Andrey Konovalov <andrey.konovalov@linaro.org> | 2023-09-28 21:55:33 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2023-10-06 02:39:05 +0300 |
| commit | b2b5129d0c3b7658d65ba0a1ad17355b2cc7c546 (patch) | |
| tree | b4c4adf8a761583b7a975b9a93f96c7b0f0e4d02 | |
| parent | ff41de7ba1f92ab445473177f9c9107baf2debda (diff) | |
libcamera: converter: A few fixes to ConverterFactoryBase documentation
The description of ConverterFactoryBase::registerType() referred to
a converter factory as "converter class" and "converter". Fix that.
Also make the descriptions of ConverterFactoryBase::compatibles() and
ConverterFactoryBase::create() a bit more specific.
Signed-off-by: Andrey Konovalov <andrey.konovalov@linaro.org>
Reviewed-by: Mattijs Korpershoek <mkorpershoek@baylibre.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
| -rw-r--r-- | src/libcamera/converter.cpp | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp index fa0f1ec8..802759de 100644 --- a/src/libcamera/converter.cpp +++ b/src/libcamera/converter.cpp @@ -199,16 +199,18 @@ ConverterFactoryBase::ConverterFactoryBase(const std::string name, std::initiali /** * \fn ConverterFactoryBase::compatibles() - * \return The names compatibles + * \return The list of compatible name aliases of the converter */ /** - * \brief Create an instance of the converter corresponding to a named factory - * \param[in] media Name of the factory + * \brief Create an instance of the converter corresponding to the media device + * \param[in] media The media device to create the converter for * - * \return A unique pointer to a new instance of the converter subclass - * corresponding to the named factory or one of its alias. Otherwise a null - * pointer if no such factory exists + * The converter is created by matching the factory name or any of its + * compatible aliases with the media device driver name. + * + * \return A new instance of the converter subclass corresponding to the media + * device, or null if the media device driver name doesn't match anything */ std::unique_ptr<Converter> ConverterFactoryBase::create(MediaDevice *media) { @@ -236,10 +238,11 @@ std::unique_ptr<Converter> ConverterFactoryBase::create(MediaDevice *media) } /** - * \brief Add a converter class to the registry + * \brief Add a converter factory to the registry * \param[in] factory Factory to use to construct the converter class * - * The caller is responsible to guarantee the uniqueness of the converter name. + * The caller is responsible to guarantee the uniqueness of the converter + * factory name. */ void ConverterFactoryBase::registerType(ConverterFactoryBase *factory) { |