{"id":19061,"url":"https://patchwork.libcamera.org/api/patches/19061/?format=json","web_url":"https://patchwork.libcamera.org/patch/19061/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/projects/1/?format=json","name":"libcamera","link_name":"libcamera","list_id":"libcamera_core","list_email":"libcamera-devel@lists.libcamera.org","web_url":"","scm_url":"","webscm_url":""},"msgid":"<20230920151921.31273-2-andrey.konovalov@linaro.org>","date":"2023-09-20T15:19:18","name":"[libcamera-devel,v2,1/4] libcamera: converter: a few fixes to ConverterFactoryBase documentation","commit_ref":null,"pull_url":null,"state":"superseded","archived":false,"hash":"b6241a848749ca2be898e6838e76cf1b2c598be0","submitter":{"id":25,"url":"https://patchwork.libcamera.org/api/people/25/?format=json","name":"Andrey Konovalov","email":"andrey.konovalov@linaro.org"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/19061/mbox/","series":[{"id":4033,"url":"https://patchwork.libcamera.org/api/series/4033/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4033","date":"2023-09-20T15:19:17","name":"libcamera: converter: generalize Converter to remove MediaDevice dependency","version":2,"mbox":"https://patchwork.libcamera.org/series/4033/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19061/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19061/checks/","tags":{},"headers":{"Return-Path":"<libcamera-devel-bounces@lists.libcamera.org>","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 14159BE080\n\tfor <parsemail@patchwork.libcamera.org>;\n\tWed, 20 Sep 2023 15:19:49 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BE16661EA6;\n\tWed, 20 Sep 2023 17:19:48 +0200 (CEST)","from mail-lj1-x231.google.com (mail-lj1-x231.google.com\n\t[IPv6:2a00:1450:4864:20::231])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3226A60388\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 20 Sep 2023 17:19:47 +0200 (CEST)","by mail-lj1-x231.google.com with SMTP id\n\t38308e7fff4ca-2bfed7c4e6dso74010521fa.1\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tWed, 20 Sep 2023 08:19:47 -0700 (PDT)","from Lat-5310.. ([87.116.162.81]) by smtp.gmail.com with ESMTPSA id\n\th24-20020a170906829800b009ae0042e48bsm5376736ejx.5.2023.09.20.08.19.45\n\t(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n\tWed, 20 Sep 2023 08:19:46 -0700 (PDT)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1695223188;\n\tbh=cLqnvuCYesf4LzJla4naO3hwhosEhFW4p3wRdVojALI=;\n\th=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=3DR+2wvXRfguEjrIHIZqU9qXhI9QVn06OHBbTUnRMu/QQykWrU57zj4YxkXdl34tm\n\txbw51pLKJNSXEBcDIrbcWugx2pVMLrunet+Ys+b96NAlyEx54sWE/LPWGVlLbkKQoI\n\t2bGAV5O31xcQQHNCIZWr0FzAW05BjVrD816qqGPcqYGdyBZrBAhJNjgadCaWkIQhkA\n\tHX3ZG540uX9YhGScOAMs9UynkqAS/ccWYAex7vQ7UXB7VSweSK+YdZg2ZXSSfBD7Zv\n\tMZ0RtLmkKE7SNoyK9Uq+u1+jS7cnN25QfeZlCLq1WPs3ONoUOPZhhJUiZG5D0FwhFq\n\tiuvSbuMijGyAw==","v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=linaro.org; s=google; t=1695223186; x=1695827986;\n\tdarn=lists.libcamera.org; \n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:from:to:cc:subject:date\n\t:message-id:reply-to;\n\tbh=S2brHV0UWTwGPZcCBUIQTOIhY0SvitvKrOiswkeZSYM=;\n\tb=YDWvHaz0JSrd7T+MqALPO0tNhH0iFvtpJabF9F0iPycvxtUyW8FRPngr7oV+tSMjLC\n\tonkGZEqh5vwtrpvXCrn9mOlwMOEf41GIbET6Mwkij11n4v2tUHmdBxWJf4vvh6s3rkIZ\n\tBawSigaGQf8fRwVRSaDway/+Meqgi4Kta+jdi7KM09UhenpFsEvERexUANjNPEVb0FU1\n\t7CA2E9E1OajEUq8IjKcDmSbpTrF5BGtRZSYiOLxqop+vuTrVOocA3PGZHpZ9cywadDm4\n\t/+2c+HHrL1OyhIXLGpd2qJgCIZjtMcVdn9OOxdtVgCA8gyvNdy8iet+k+0VNoZrfwI0T\n\tHXwA=="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (2048-bit key; \n\tunprotected) header.d=linaro.org\n\theader.i=@linaro.org header.b=\"YDWvHaz0\"; \n\tdkim-atps=neutral","X-Google-DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20230601; t=1695223186; x=1695827986;\n\th=content-transfer-encoding:mime-version:references:in-reply-to\n\t:message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n\t:subject:date:message-id:reply-to;\n\tbh=S2brHV0UWTwGPZcCBUIQTOIhY0SvitvKrOiswkeZSYM=;\n\tb=T1zRNSbfG9j0Gu42FqKMxufNuoFSm1b3EdolSq6i2y6AM1PNA6Lcdyw20Kki0GvbgD\n\tsGX0St0DX9EVXLYYrMrr+jiswvZACTr4M5yHBcB30jxZQkq255iGEczIp3bPeFmKSHdw\n\tyT7v9CBoJusFTwOSx5gEz5WxTdRtA3QmaxGEaEuHjTycCnFPUpDQgEzC18vspspFU2Gr\n\txsJp3wU0IxQoGeTjJD8dU2l4j4Zyk1RguBH8eLTP1khKA0DAWibFRRzlAQSVd1uPo9T9\n\tfWlSBOueDEeQnoADJiFiLsZEjHMnrLksA3Sjlko8NW+MDjxtVkh5Fro6rTO5hXLWWXZ8\n\tRz7g==","X-Gm-Message-State":"AOJu0YwdbV5doXGn5B4IB3iOEjfte4KrEwdBYzkaNKh9FpF2HL0+VnGo\n\tQlKi67VMMLWoJ14EIKV25QtC85zn7DF0JdJvYCc=","X-Google-Smtp-Source":"AGHT+IEF+FEJkbw1jq88NkFQsQPsdpcU6O8fNJZEhOG7JbdxBrJxI8MuXKNkVkQ7QLZf6P7A0s7TIA==","X-Received":"by 2002:a2e:878d:0:b0:2bf:ec8e:97c9 with SMTP id\n\tn13-20020a2e878d000000b002bfec8e97c9mr2348057lji.17.1695223186569; \n\tWed, 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","Content-Transfer-Encoding":"7bit","Subject":"[libcamera-devel] [PATCH v2 1/4] libcamera: converter: a few fixes\n\tto ConverterFactoryBase documentation","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"<libcamera-devel.lists.libcamera.org>","List-Unsubscribe":"<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>","List-Archive":"<https://lists.libcamera.org/pipermail/libcamera-devel/>","List-Post":"<mailto:libcamera-devel@lists.libcamera.org>","List-Help":"<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>","List-Subscribe":"<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>","From":"Andrey Konovalov via libcamera-devel\n\t<libcamera-devel@lists.libcamera.org>","Reply-To":"Andrey Konovalov <andrey.konovalov@linaro.org>","Cc":"jacopo.mondi@ideasonboard.com, bryan.odonoghue@linaro.org,\n\tsrinivas.kandagatla@linaro.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>"},"content":"Signed-off-by: Andrey Konovalov <andrey.konovalov@linaro.org>\n---\n src/libcamera/converter.cpp | 17 ++++++++++-------\n 1 file changed, 10 insertions(+), 7 deletions(-)","diff":"diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp\nindex fa0f1ec8..466f8421 100644\n--- a/src/libcamera/converter.cpp\n+++ b/src/libcamera/converter.cpp\n@@ -199,16 +199,18 @@ ConverterFactoryBase::ConverterFactoryBase(const std::string name, std::initiali\n \n /**\n  * \\fn ConverterFactoryBase::compatibles()\n- * \\return The names compatibles\n+ * \\return The compatibles\n  */\n \n /**\n- * \\brief Create an instance of the converter corresponding to a named factory\n- * \\param[in] media Name of the factory\n+ * \\brief Create an instance of the converter corresponding to the media device\n+ * \\param[in] media the media device to create the converter for\n  *\n  * \\return A unique pointer to a new instance of the converter subclass\n- * corresponding to the named factory or one of its alias. Otherwise a null\n- * pointer if no such factory exists\n+ * corresponding to the media device. The converter is created by the factory\n+ * the name or the alias of which equals to the media device driver name.\n+ * If the media device driver name doesn't match anything a null pointer is\n+ * returned.\n  */\n std::unique_ptr<Converter> ConverterFactoryBase::create(MediaDevice *media)\n {\n@@ -236,10 +238,11 @@ std::unique_ptr<Converter> ConverterFactoryBase::create(MediaDevice *media)\n }\n \n /**\n- * \\brief Add a converter class to the registry\n+ * \\brief Add a converter factory to the registry\n  * \\param[in] factory Factory to use to construct the converter class\n  *\n- * The caller is responsible to guarantee the uniqueness of the converter name.\n+ * The caller is responsible to guarantee the uniqueness of the converter\n+ * factory name.\n  */\n void ConverterFactoryBase::registerType(ConverterFactoryBase *factory)\n {\n","prefixes":["libcamera-devel","v2","1/4"]}