From patchwork Wed Oct 19 11:04:31 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Pinchart X-Patchwork-Id: 17634 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 53491C327C for ; Wed, 19 Oct 2022 11:05:03 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id ECFC662E57; Wed, 19 Oct 2022 13:05:02 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1666177503; bh=6nurTBtSZIaANKgyuDwAbCr+Xxcu8zjq+5iaqFEwX5A=; h=To:Date:In-Reply-To:References:Subject:List-Id:List-Unsubscribe: List-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To: From; b=ol9uCOuL1mh6d+lwOxyZMj/LrDrO8qHYFH/sduWsxcEA8wX+cHRlOWnABggoNMpC4 lSNdMl/M3ZABHuji8gtMr1Yr2xKGjvTk9YMd/qqNJj7Tez1gdXSFMiFiqK9J5XtDSP Ce0MzJufsitxHR5urUSEhVXq+/6az81wB2M6+L59hdZl4LaAhgdkGrtM3F60WaKnFk bDH7/RcjkewBMP6LDO0cpiiE4ujMWlAiBCnu0q+1loOWhQAGo5V3SCaCtbdZnSrJTH s7ABwxzrcAa3cS1/MHBFZ1jYLMBJTT7imheOtqjDOkt8RHQUSXZvbNvT8bVTCZnjse HW9LCSwyqpjhw== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id D39DF62E45 for ; Wed, 19 Oct 2022 13:04:59 +0200 (CEST) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="mE81KUxG"; dkim-atps=neutral Received: from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi [62.78.145.57]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 6BE7E5A4 for ; Wed, 19 Oct 2022 13:04:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1666177499; bh=6nurTBtSZIaANKgyuDwAbCr+Xxcu8zjq+5iaqFEwX5A=; h=From:To:Subject:Date:In-Reply-To:References:From; b=mE81KUxGYCnEe3og6eoQ6xm7Y0tyyPMqio1gyEdYDkdBG9Pi+m5KvfAJbB7iuzeBc h6Y14eum/UMxXkhrpaQHbFosW9ZKZ9seSNtqVpAMe1vAl2XoiClX/9HIZBT0BbacNL EjSeXtAq5s/atVe+iLxEyyzhTPubgiYUd8zfugMw= To: libcamera-devel@lists.libcamera.org Date: Wed, 19 Oct 2022 14:04:31 +0300 Message-Id: <20221019110434.17767-2-laurent.pinchart@ideasonboard.com> X-Mailer: git-send-email 2.37.3 In-Reply-To: <20221019110434.17767-1-laurent.pinchart@ideasonboard.com> References: <20221019110434.17767-1-laurent.pinchart@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v1 1/4] ipa: Drop period at end of \brief or \param 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: Laurent Pinchart via libcamera-devel From: Laurent Pinchart Reply-To: Laurent Pinchart Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" A few periods crept in at the end of Doxygen \brief or \param statements in the src/ipa/ directory. Remove them all in one go. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham Reviewed-by: Jacopo Mondi --- src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++--------- src/ipa/ipu3/ipa_context.cpp | 6 +++--- src/ipa/libipa/algorithm.cpp | 2 +- src/ipa/libipa/histogram.cpp | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp index b00a34f9e090..75632aa39d21 100644 --- a/src/ipa/ipu3/algorithms/af.cpp +++ b/src/ipa/ipu3/algorithms/af.cpp @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context) } /** - * \brief AF variance comparison. + * \brief AF variance comparison * \param[in] context The IPA context - * \param[in] min_step The VCM movement step. + * \param[in] min_step The VCM movement step * * We always pick the largest variance to replace the previous one. The image * with a larger variance also indicates it is a clearer image than previous @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step) } /** - * \brief Determine the frame to be ignored. + * \brief Determine the frame to be ignored * \return Return True if the frame should be ignored, false otherwise */ bool Af::afNeedIgnoreFrame() @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame() } /** - * \brief Reset frame ignore counter. + * \brief Reset frame ignore counter */ void Af::afIgnoreFrameReset() { @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span y_items, bool isY1) } /** - * \brief Determine out-of-focus situation. - * \param[in] context The IPA context. + * \brief Determine out-of-focus situation + * \param[in] context The IPA context * * Out-of-focus means that the variance change rate for a focused and a new * variance is greater than a threshold. @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context) } /** - * \brief Determine the max contrast image and lens position. - * \param[in] context The IPA context. + * \brief Determine the max contrast image and lens position + * \param[in] context The IPA context * \param[in] frame The frame context sequence number * \param[in] frameContext The current frame context - * \param[in] stats The statistics buffer of IPU3. + * \param[in] stats The statistics buffer of IPU3 * * Ideally, a clear image also has a relatively higher contrast. So, every * image for each focus step should be tested to find an optimal focus step. diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp index f276227c1ecc..68f017b04751 100644 --- a/src/ipa/ipu3/ipa_context.cpp +++ b/src/ipa/ipu3/ipa_context.cpp @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 { * \brief AF grid configuration of the IPA * * \var IPASessionConfiguration::af.afGrid - * \brief AF scene grid configuration. + * \brief AF scene grid configuration */ /** @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 { * \brief Current position of the lens * * \var IPAActiveState::af.maxVariance - * \brief The maximum variance of the current image. + * \brief The maximum variance of the current image * * \var IPAActiveState::af.stable - * \brief It is set to true, if the best focus is found. + * \brief It is set to true, if the best focus is found */ /** diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp index c152b885aee1..55abddab2b0a 100644 --- a/src/ipa/libipa/algorithm.cpp +++ b/src/ipa/libipa/algorithm.cpp @@ -72,7 +72,7 @@ namespace ipa { * \param[in] context The shared IPA context * \param[in] frame The frame context sequence number * \param[in] frameContext The FrameContext for this frame - * \param[out] params The ISP specific parameters. + * \param[out] params The ISP specific parameters * * This function is called for every frame when the camera is running before it * is processed by the ISP to prepare the ISP processing parameters for that diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp index 69b461779a1f..6b5cde8e0ab3 100644 --- a/src/ipa/libipa/histogram.cpp +++ b/src/ipa/libipa/histogram.cpp @@ -53,7 +53,7 @@ Histogram::Histogram(Span data) */ /** - * \brief Cumulative frequency up to a (fractional) point in a bin. + * \brief Cumulative frequency up to a (fractional) point in a bin * \param[in] bin The bin up to which to cumulate * * With F(p) the cumulative frequency of the histogram, the value is 0 at