From patchwork Wed Sep 20 15:19:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrey Konovalov X-Patchwork-Id: 19061 Return-Path: X-Original-To: parsemail@patchwork.libcamera.org Delivered-To: parsemail@patchwork.libcamera.org Received: from lancelot.ideasonboard.com (lancelot.ideasonboard.com [92.243.16.209]) by patchwork.libcamera.org (Postfix) with ESMTPS id 14159BE080 for ; Wed, 20 Sep 2023 15:19:49 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id BE16661EA6; Wed, 20 Sep 2023 17:19:48 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1695223188; bh=cLqnvuCYesf4LzJla4naO3hwhosEhFW4p3wRdVojALI=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc: From; b=3DR+2wvXRfguEjrIHIZqU9qXhI9QVn06OHBbTUnRMu/QQykWrU57zj4YxkXdl34tm xbw51pLKJNSXEBcDIrbcWugx2pVMLrunet+Ys+b96NAlyEx54sWE/LPWGVlLbkKQoI 2bGAV5O31xcQQHNCIZWr0FzAW05BjVrD816qqGPcqYGdyBZrBAhJNjgadCaWkIQhkA HX3ZG540uX9YhGScOAMs9UynkqAS/ccWYAex7vQ7UXB7VSweSK+YdZg2ZXSSfBD7Zv MZ0RtLmkKE7SNoyK9Uq+u1+jS7cnN25QfeZlCLq1WPs3ONoUOPZhhJUiZG5D0FwhFq iuvSbuMijGyAw== Received: from mail-lj1-x231.google.com (mail-lj1-x231.google.com [IPv6:2a00:1450:4864:20::231]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 3226A60388 for ; Wed, 20 Sep 2023 17:19:47 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="YDWvHaz0"; dkim-atps=neutral Received: by mail-lj1-x231.google.com with SMTP id 38308e7fff4ca-2bfed7c4e6dso74010521fa.1 for ; Wed, 20 Sep 2023 08:19:47 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1695223186; x=1695827986; darn=lists.libcamera.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=S2brHV0UWTwGPZcCBUIQTOIhY0SvitvKrOiswkeZSYM=; b=YDWvHaz0JSrd7T+MqALPO0tNhH0iFvtpJabF9F0iPycvxtUyW8FRPngr7oV+tSMjLC onkGZEqh5vwtrpvXCrn9mOlwMOEf41GIbET6Mwkij11n4v2tUHmdBxWJf4vvh6s3rkIZ BawSigaGQf8fRwVRSaDway/+Meqgi4Kta+jdi7KM09UhenpFsEvERexUANjNPEVb0FU1 7CA2E9E1OajEUq8IjKcDmSbpTrF5BGtRZSYiOLxqop+vuTrVOocA3PGZHpZ9cywadDm4 /+2c+HHrL1OyhIXLGpd2qJgCIZjtMcVdn9OOxdtVgCA8gyvNdy8iet+k+0VNoZrfwI0T HXwA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695223186; x=1695827986; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=S2brHV0UWTwGPZcCBUIQTOIhY0SvitvKrOiswkeZSYM=; b=T1zRNSbfG9j0Gu42FqKMxufNuoFSm1b3EdolSq6i2y6AM1PNA6Lcdyw20Kki0GvbgD sGX0St0DX9EVXLYYrMrr+jiswvZACTr4M5yHBcB30jxZQkq255iGEczIp3bPeFmKSHdw yT7v9CBoJusFTwOSx5gEz5WxTdRtA3QmaxGEaEuHjTycCnFPUpDQgEzC18vspspFU2Gr xsJp3wU0IxQoGeTjJD8dU2l4j4Zyk1RguBH8eLTP1khKA0DAWibFRRzlAQSVd1uPo9T9 fWlSBOueDEeQnoADJiFiLsZEjHMnrLksA3Sjlko8NW+MDjxtVkh5Fro6rTO5hXLWWXZ8 Rz7g== X-Gm-Message-State: AOJu0YwdbV5doXGn5B4IB3iOEjfte4KrEwdBYzkaNKh9FpF2HL0+VnGo QlKi67VMMLWoJ14EIKV25QtC85zn7DF0JdJvYCc= X-Google-Smtp-Source: AGHT+IEF+FEJkbw1jq88NkFQsQPsdpcU6O8fNJZEhOG7JbdxBrJxI8MuXKNkVkQ7QLZf6P7A0s7TIA== X-Received: by 2002:a2e:878d:0:b0:2bf:ec8e:97c9 with SMTP id n13-20020a2e878d000000b002bfec8e97c9mr2348057lji.17.1695223186569; Wed, 20 Sep 2023 08:19:46 -0700 (PDT) Received: from Lat-5310.. ([87.116.162.81]) by smtp.gmail.com with ESMTPSA id h24-20020a170906829800b009ae0042e48bsm5376736ejx.5.2023.09.20.08.19.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 20 Sep 2023 08:19:46 -0700 (PDT) To: libcamera-devel@lists.libcamera.org Date: Wed, 20 Sep 2023 18:19:18 +0300 Message-Id: <20230920151921.31273-2-andrey.konovalov@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230920151921.31273-1-andrey.konovalov@linaro.org> References: <20230920151921.31273-1-andrey.konovalov@linaro.org> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 1/4] libcamera: converter: a few fixes to ConverterFactoryBase documentation X-BeenThere: libcamera-devel@lists.libcamera.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-Patchwork-Original-From: Andrey Konovalov via libcamera-devel From: Andrey Konovalov Reply-To: Andrey Konovalov Cc: jacopo.mondi@ideasonboard.com, bryan.odonoghue@linaro.org, srinivas.kandagatla@linaro.org Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" Signed-off-by: Andrey Konovalov --- src/libcamera/converter.cpp | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp index fa0f1ec8..466f8421 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 compatibles */ /** - * \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 + * corresponding to the media device. The converter is created by the factory + * the name or the alias of which equals to the media device driver name. + * If the media device driver name doesn't match anything a null pointer is + * returned. */ std::unique_ptr ConverterFactoryBase::create(MediaDevice *media) { @@ -236,10 +238,11 @@ std::unique_ptr 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) {