From patchwork Thu Sep 28 18:55:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrey Konovalov X-Patchwork-Id: 19094 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 0F02DC0F2A for ; Thu, 28 Sep 2023 18:56:42 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id BFFF162965; Thu, 28 Sep 2023 20:56:41 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1695927401; bh=JBU65R7c//9e4z7g5JrHGKqa8T0iaHXFk0mO+RreV7A=; 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=jEKdFsqf3bwwtvDyKAR+DgqLfyx+R1KK1dFPsmIkycikc0zWP/YLTt/iMIy4m/vEU 5RkNydljFLlS/35X8M1GEGbHBgF+Z/XQ9Ickzm12/TIm16UQCn9IGTcG2/DnB6Nv5x 7Dhxgbi21bSJwRmt2taRBPlbxQk6Ao+2G4JNai/BL+2Xv7uGL1ra6QGlxPRQiDsbGw l9UofUM02sec4B1DTlqwK+J98EFw9sd1QhBevEGit4Co2Y43BnG+AOOG2MwbrVWpmZ LWoho8xDISmgV7l6IrLmDzDeGpvH8zmbCZlfp0+cH1U9Ab2sLvt6xn6d8fjLKF84yD 5zNYCL36io5kQ== Received: from mail-wr1-x42e.google.com (mail-wr1-x42e.google.com [IPv6:2a00:1450:4864:20::42e]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 4862761DE3 for ; Thu, 28 Sep 2023 20:56:40 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (2048-bit key; unprotected) header.d=linaro.org header.i=@linaro.org header.b="ul4OkIr4"; dkim-atps=neutral Received: by mail-wr1-x42e.google.com with SMTP id ffacd0b85a97d-3231dff4343so6242757f8f.0 for ; Thu, 28 Sep 2023 11:56:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1695927400; x=1696532200; 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=ypxvKBx6mrteqp8A4cjPERuJutJlBXx0XrDjTtsVzPY=; b=ul4OkIr42jnyq4hCWGfQ3kLoxKP4qS7sKClj5yfQQhESPDoe6608O7Znk5pqVF8DI1 18xw0v8GKhAJzFPH44hlPoQtz2sHgZM/gMqA4DtkJjxMeBXTBBvGKyQnjuRpOVOdUdc1 1b1MZGTYSdVH3cSncr5gruTuy8yQ4jxese1PaGYnQUlPwh8oGfe72S9XctCpzhGkGbX7 sunGwpy8SwE0RqL8fPY19CpgenhU37NFS0jsTs8pjl5cKVP/ITKd7RPVUWFXlW/bg0Vi e4mYSS9+9skyIuIk0XpPXYOVK12rhXrMDfkqn/T2v15d1FrSyTywweXMCgUE0KcT9RTT vLrw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695927400; x=1696532200; 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=ypxvKBx6mrteqp8A4cjPERuJutJlBXx0XrDjTtsVzPY=; b=LzHQgS3e5IPPlpbjkmWXoOi+RnyTF2wEeTXTyZTzoqFT9PtSnar/RNSsGMr4lCGfPC heD6wmiAPfONTg1Bj4zjCWbcbKdQ/N0xtHWvmtkL2hT64u7kWhQfLrBoIqGDtmdwrMiJ F1PZ39y6rkvdEHQ7Kb6PRjMKESl/jWD4V6CPllu3zP4NqbN5V+hk/w0Z0/jMTwwU8WlU oI+TqzWQofgkr16unk7OwR+SbVZ7JQppa5T2V6Ew9TOmrVXvuggYo3HQly7sUUiHERLm J2ua6PM8NxCCExc5NiF8sO7Ue7xpWzDSQx+0PZCgiyTKz5NxsD5uP9LDMeceDxW8PGeR DrBA== X-Gm-Message-State: AOJu0YzMhunRKA+vSLDxB1KQWjbAmdil7N1d/YmwV/LCMUSohvGqnpGR T+BqyGHWu/aTqk4Lhnq+lJOcEz4xCaxzG/5nm6c= X-Google-Smtp-Source: AGHT+IFR4xGaH2DlR0ZodomGberS7Pl8FnRVon25Mbl+UFSWACLfCFVA5r2H8xcvTk2piNAxu/N98w== X-Received: by 2002:a5d:4052:0:b0:31f:eb45:462e with SMTP id w18-20020a5d4052000000b0031feb45462emr1897064wrp.28.1695927399933; Thu, 28 Sep 2023 11:56:39 -0700 (PDT) Received: from Lat-5310.. ([87.116.164.210]) by smtp.gmail.com with ESMTPSA id u1-20020adfed41000000b003247d3e5d99sm890842wro.55.2023.09.28.11.56.39 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 28 Sep 2023 11:56:39 -0700 (PDT) To: libcamera-devel@lists.libcamera.org Date: Thu, 28 Sep 2023 21:55:33 +0300 Message-Id: <20230928185537.20178-2-andrey.konovalov@linaro.org> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230928185537.20178-1-andrey.konovalov@linaro.org> References: <20230928185537.20178-1-andrey.konovalov@linaro.org> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v3 1/5] 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" 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 Reviewed-by: Mattijs Korpershoek Reviewed-by: Laurent Pinchart --- src/libcamera/converter.cpp | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/src/libcamera/converter.cpp b/src/libcamera/converter.cpp index fa0f1ec8..15701363 100644 --- a/src/libcamera/converter.cpp +++ b/src/libcamera/converter.cpp @@ -199,16 +199,19 @@ 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 + * corresponding to the media device. The converter is created by matching + * the factory name or any of its compatible aliases with 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 +239,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) {