From patchwork Fri Jan 5 16:41:00 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 19372 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 B083EC3240 for ; Fri, 5 Jan 2024 16:41:25 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 179D562B32; Fri, 5 Jan 2024 17:41:24 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1704472884; bh=AHU7PEquIJrGoeUzU1Luatu5O8VnvlbsJg5NrXatAKA=; 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=CX7QZB8EYzb7B7rOyn/sFSB9w2BsDBOZxA0na8yp+FKlNLTFxPQf4YCi3BN0XONTQ 2MnsrfcffRe7z8BNKAHjDG3N9Zj0dQY4CEcRpu58Kb2+Er/qyK+QTy7/sMPm/xP0wY 62owd0t2qeBlkS+B3ESocjr1jHLMpogOel+oqi6sDnKKrrLOPF+eKSIk5MeSHM7TO8 qHgwRaeUrWYd4UDr9MhOO634a3tNZfRscOpgyd/xBF2G6cCymbfPDeLnHUFIOp7WhP 94zBYgCDtNo2iFSiqGCJU1DyxWNueQUll8I9W/OxDK1KIGYgnSYkYeVe//LTzsrh8B OH2OKQ+XMPfWg== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [213.167.242.64]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id EF96161D81 for ; Fri, 5 Jan 2024 17:41:21 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="Ehe07KGM"; dkim-atps=neutral Received: from mail.ideasonboard.com (cpc141996-chfd3-2-0-cust928.12-3.cable.virginm.net [86.13.91.161]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 5CD54D49; Fri, 5 Jan 2024 17:40:20 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1704472820; bh=AHU7PEquIJrGoeUzU1Luatu5O8VnvlbsJg5NrXatAKA=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=Ehe07KGMZWSaz7FRTIdjqN1OI7DKm9XzpeR5WOiWofXw45Zgo89I6Y1ukg2LUYO8P ip92/iHWE97Lggw3WJ0s2r4772E7Lk1DwYtNaS3ZdSBmgcy9jk8V3C1tdUkauxluky VS3G6BRqpyJN3yenG8V3ihhNytpELF/FVjv/K1XE= To: libcamera-devel@lists.libcamera.org Date: Fri, 5 Jan 2024 16:41:00 +0000 Message-Id: <20240105164104.78398-2-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240105164104.78398-1-dan.scally@ideasonboard.com> References: <20240105164104.78398-1-dan.scally@ideasonboard.com> MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH v2 1/5] libcamera: geometry: Correct doxygen reference to classes 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: Daniel Scally via libcamera-devel From: Dan Scally Reply-To: Daniel Scally Cc: Jacopo Mondi Errors-To: libcamera-devel-bounces@lists.libcamera.org Sender: "libcamera-devel" The classes Rectangle, Size and SizeRange are referenced with \struct in the doxygen comments in geometry.cpp. Correct the reference to \class to better reflect their definition. Reviewed-by: Jacopo Mondi Reviewed-by: Laurent Pinchart Signed-off-by: Daniel Scally --- Changes in v2: - None src/libcamera/geometry.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index e50b46c5..8d85b758 100644 --- a/src/libcamera/geometry.cpp +++ b/src/libcamera/geometry.cpp @@ -95,10 +95,10 @@ std::ostream &operator<<(std::ostream &out, const Point &p) } /** - * \struct Size + * \class Size * \brief Describe a two-dimensional size * - * The Size structure defines a two-dimensional size with integer precision. + * The Size class defines a two-dimensional size with integer precision. */ /** @@ -455,7 +455,7 @@ std::ostream &operator<<(std::ostream &out, const Size &s) } /** - * \struct SizeRange + * \class SizeRange * \brief Describe a range of sizes * * A SizeRange describes a range of sizes included in the [min, max] interval @@ -589,7 +589,7 @@ std::ostream &operator<<(std::ostream &out, const SizeRange &sr) } /** - * \struct Rectangle + * \class Rectangle * \brief Describe a rectangle's position and dimensions * * Rectangles are used to identify an area of an image. They are specified by