Mirror/libcamera
1
0
Fork 0
mirror of https://git.libcamera.org/libcamera/libcamera.git synced 2025-07-13 15:29:45 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

libcamera: converter: A few fixes to ConverterFactoryBase documentation

Browse source 
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>
This commit is contained in:
Andrey Konovalov 2023-09-28 21:55:33 +03:00 • committed by Laurent Pinchart
parent ff41de7ba1
commit b2b5129d0c
1 changed files with 11 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

19
src/libcamera/converter.cpp
View file

@ -199,16 +199,18 @@ ConverterFactoryBase::ConverterFactoryBase(const std::string name, std::initiali
/** /**
* \fn ConverterFactoryBase::compatibles() * \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 * \brief Create an instance of the converter corresponding to the media device
* \param[in] media Name of the factory * \param[in] media The media device to create the converter for
* *
* \return A unique pointer to a new instance of the converter subclass * The converter is created by matching the factory name or any of its
* corresponding to the named factory or one of its alias. Otherwise a null * compatible aliases with the media device driver name.
* pointer if no such factory exists *
* \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) 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 * \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) void ConverterFactoryBase::registerType(ConverterFactoryBase *factory)
{ {