{"id":21399,"url":"https://patchwork.libcamera.org/api/patches/21399/?format=json","web_url":"https://patchwork.libcamera.org/patch/21399/","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":"<20240927134624.801004-7-mzamazal@redhat.com>","date":"2024-09-27T13:46:12","name":"[v8,06/18] libcamera: software_isp: Remove final dots in debayer.cpp docstrings","commit_ref":"e334227dcc1584be03ca2220ea895da5725c39b8","pull_url":null,"state":"accepted","archived":false,"hash":"c45739d9c7ada80ed5dc4f6f51cc435180dd42c6","submitter":{"id":177,"url":"https://patchwork.libcamera.org/api/people/177/?format=json","name":"Milan Zamazal","email":"mzamazal@redhat.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/21399/mbox/","series":[{"id":4634,"url":"https://patchwork.libcamera.org/api/series/4634/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4634","date":"2024-09-27T13:46:06","name":"Software ISP refactoring","version":8,"mbox":"https://patchwork.libcamera.org/series/4634/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/21399/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/21399/checks/","tags":{},"headers":{"Return-Path":"","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 81AC8C3257\n\tfor ;\n\tFri, 27 Sep 2024 13:46:58 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 266866352A;\n\tFri, 27 Sep 2024 15:46:58 +0200 (CEST)","from us-smtp-delivery-124.mimecast.com\n\t(us-smtp-delivery-124.mimecast.com [170.10.129.124])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 3FAFB6351A\n\tfor ;\n\tFri, 27 Sep 2024 15:46:54 +0200 (CEST)","from mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com\n\t(ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63])\n\tby relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3,\n\tcipher=TLS_AES_256_GCM_SHA384) id us-mta-145-mjW1TugSM3-g28Q50kkU3A-1;\n\tFri, 27 Sep 2024 09:46:47 -0400","from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (unknown\n\t[10.30.177.40])\n\t(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)\n\tkey-exchange X25519 server-signature RSA-PSS (2048 bits)\n\tserver-digest SHA256) (No client certificate requested)\n\tby mx-prod-mc-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTPS id CD8531975AD7; Fri, 27 Sep 2024 13:46:46 +0000 (UTC)","from nuthatch.redhat.com (unknown [10.45.224.123])\n\tby mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix)\n\twith ESMTP id E4E451956054; Fri, 27 Sep 2024 13:46:44 +0000 (UTC)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=redhat.com header.i=@redhat.com\n\theader.b=\"NNWfW2V4\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com;\n\ts=mimecast20190719; t=1727444813;\n\th=from:from:reply-to:subject:subject:date:date:message-id:message-id:\n\tto:to:cc:cc:mime-version:mime-version:content-type:content-type:\n\tcontent-transfer-encoding:content-transfer-encoding:\n\tin-reply-to:in-reply-to:references:references;\n\tbh=/CbV7nZyRGUDSVyG2i0Fgjh6k0b1k/FnugA5S4yKk6c=;\n\tb=NNWfW2V43sFxFdkMpWryhdsjpYqYV05FAqLtA4wWNlRUwRly5c/s9Y+mYaieit5rZc8vlW\n\tQLK5IIbjauDO+Bg9t668vzmBnYkpA/lacTZla9Fxz39G8JLXJUO5IPAQX+MhLU1lSIeGc+\n\tQ5wf8CKVxpoQx4ohHe8XOFmLyT/4NSM=","X-MC-Unique":"mjW1TugSM3-g28Q50kkU3A-1","From":"Milan Zamazal ","To":"libcamera-devel@lists.libcamera.org","Cc":"Milan Zamazal ,\n\tUmang Jain ,\n\tLaurent Pinchart ,\n\tDaniel Scally ,\n\tKieran Bingham ","Subject":"[PATCH v8 06/18] libcamera: software_isp: Remove final dots in\n\tdebayer.cpp docstrings","Date":"Fri, 27 Sep 2024 15:46:12 +0200","Message-ID":"<20240927134624.801004-7-mzamazal@redhat.com>","In-Reply-To":"<20240927134624.801004-1-mzamazal@redhat.com>","References":"<20240927134624.801004-1-mzamazal@redhat.com>","MIME-Version":"1.0","X-Scanned-By":"MIMEDefang 3.0 on 10.30.177.40","X-Mimecast-Spam-Score":"0","X-Mimecast-Originator":"redhat.com","Content-Transfer-Encoding":"8bit","Content-Type":"text/plain; charset=\"US-ASCII\"; x-default=true","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.29","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The policy and the style checker require that \\brief, \\param and \\return\ntexts don't finish with a dot. This needs to be fixed in debayer.cpp.\nAlso leading spaces in a \\return statement are removed from there.\n\nSigned-off-by: Milan Zamazal \nReviewed-by: Umang Jain \nReviewed-by: Daniel Scally \nReviewed-by: Laurent Pinchart \n---\n src/libcamera/software_isp/debayer.cpp | 48 +++++++++++++-------------\n 1 file changed, 24 insertions(+), 24 deletions(-)","diff":"diff --git a/src/libcamera/software_isp/debayer.cpp b/src/libcamera/software_isp/debayer.cpp\nindex f4a299d55..db26c3809 100644\n--- a/src/libcamera/software_isp/debayer.cpp\n+++ b/src/libcamera/software_isp/debayer.cpp\n@@ -58,47 +58,47 @@ Debayer::~Debayer()\n \n /**\n * \\fn int Debayer::configure(const StreamConfiguration &inputCfg, const std::vector> &outputCfgs)\n- * \\brief Configure the debayer object according to the passed in parameters.\n- * \\param[in] inputCfg The input configuration.\n- * \\param[in] outputCfgs The output configurations.\n+ * \\brief Configure the debayer object according to the passed in parameters\n+ * \\param[in] inputCfg The input configuration\n+ * \\param[in] outputCfgs The output configurations\n *\n- * \\return 0 on success, a negative errno on failure.\n+ * \\return 0 on success, a negative errno on failure\n */\n \n /**\n * \\fn Size Debayer::patternSize(PixelFormat inputFormat)\n- * \\brief Get the width and height at which the bayer pattern repeats.\n- * \\param[in] inputFormat The input format.\n+ * \\brief Get the width and height at which the bayer pattern repeats\n+ * \\param[in] inputFormat The input format\n *\n * Valid sizes are: 2x2, 4x2 or 4x4.\n *\n- * \\return Pattern size or an empty size for unsupported inputFormats.\n+ * \\return Pattern size or an empty size for unsupported inputFormats\n */\n \n /**\n * \\fn std::vector Debayer::formats(PixelFormat inputFormat)\n- * \\brief Get the supported output formats.\n- * \\param[in] inputFormat The input format.\n+ * \\brief Get the supported output formats\n+ * \\param[in] inputFormat The input format\n *\n- * \\return All supported output formats or an empty vector if there are none.\n+ * \\return All supported output formats or an empty vector if there are none\n */\n \n /**\n * \\fn std::tuple Debayer::strideAndFrameSize(const PixelFormat &outputFormat, const Size &size)\n- * \\brief Get the stride and the frame size.\n- * \\param[in] outputFormat The output format.\n- * \\param[in] size The output size.\n+ * \\brief Get the stride and the frame size\n+ * \\param[in] outputFormat The output format\n+ * \\param[in] size The output size\n *\n * \\return A tuple of the stride and the frame size, or a tuple with 0,0 if\n- * there is no valid output config.\n+ * there is no valid output config\n */\n \n /**\n * \\fn void Debayer::process(FrameBuffer *input, FrameBuffer *output, DebayerParams params)\n- * \\brief Process the bayer data into the requested format.\n- * \\param[in] input The input buffer.\n- * \\param[in] output The output buffer.\n- * \\param[in] params The parameters to be used in debayering.\n+ * \\brief Process the bayer data into the requested format\n+ * \\param[in] input The input buffer\n+ * \\param[in] output The output buffer\n+ * \\param[in] params The parameters to be used in debayering\n *\n * \\note DebayerParams is passed by value deliberately so that a copy is passed\n * when this is run in another thread by invokeMethod().\n@@ -106,21 +106,21 @@ Debayer::~Debayer()\n \n /**\n * \\fn virtual SizeRange Debayer::sizes(PixelFormat inputFormat, const Size &inputSize)\n- * \\brief Get the supported output sizes for the given input format and size.\n- * \\param[in] inputFormat The input format.\n- * \\param[in] inputSize The input size.\n+ * \\brief Get the supported output sizes for the given input format and size\n+ * \\param[in] inputFormat The input format\n+ * \\param[in] inputSize The input size\n *\n- * \\return The valid size ranges or an empty range if there are none.\n+ * \\return The valid size ranges or an empty range if there are none\n */\n \n /**\n * \\var Signal Debayer::inputBufferReady\n- * \\brief Signals when the input buffer is ready.\n+ * \\brief Signals when the input buffer is ready\n */\n \n /**\n * \\var Signal Debayer::outputBufferReady\n- * \\brief Signals when the output buffer is ready.\n+ * \\brief Signals when the output buffer is ready\n */\n \n } /* namespace libcamera */\n","prefixes":["v8","06/18"]}