From patchwork Wed Dec 20 16:31:43 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dan Scally X-Patchwork-Id: 19332 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 1CA4EC31E9 for ; Wed, 20 Dec 2023 16:32:04 +0000 (UTC) Received: from lancelot.ideasonboard.com (localhost [IPv6:::1]) by lancelot.ideasonboard.com (Postfix) with ESMTP id 38CE962B49; Wed, 20 Dec 2023 17:32:03 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org; s=mail; t=1703089923; bh=nbwExHJuuL/mE4TtqPkG0lWeRf6Z/NSSY21y3ZwZVZ0=; h=To:Date:Subject:List-Id:List-Unsubscribe:List-Archive:List-Post: List-Help:List-Subscribe:From:Reply-To:From; b=YithQ+qvVltyUy5taT6aQNSrij/WgW12630s1/aCSIhYfmsc2SvronHvazHbJAyM+ k3CvglmAmZKSI3aVMGWzgTVAm9DtIkKFzUM37ou/AfQ4qdkAK1vQ6ZH2VJZA1d6YGB NsxUyhMQZYgFVj3l81NJvrW8pBfHEhMwiKfsJ8wtEHG3tjunRgG99xgxa0VF8LQg63 I3KDrNuBkWJzDASQ1nDtSn7yoxQ0Yyj42ustuGvzt/mc0F2vGUOrGUqjL/CTJHdJ4k fyBHVYsOUJVMBpHmZ80ND51OAS7nHpwTKeCv/YMOIBv6irA2382SJCndgzhppbRcws 75/0ajiEIyusA== Received: from perceval.ideasonboard.com (perceval.ideasonboard.com [IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647]) by lancelot.ideasonboard.com (Postfix) with ESMTPS id 652A762B2E for ; Wed, 20 Dec 2023 17:32:01 +0100 (CET) Authentication-Results: lancelot.ideasonboard.com; dkim=pass (1024-bit key; unprotected) header.d=ideasonboard.com header.i=@ideasonboard.com header.b="WnbWYwir"; 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 98164BB2; Wed, 20 Dec 2023 17:31:10 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1703089870; bh=nbwExHJuuL/mE4TtqPkG0lWeRf6Z/NSSY21y3ZwZVZ0=; h=From:To:Cc:Subject:Date:From; b=WnbWYwirnSs4SR0KzMVK3HAgffn1n7gExW/yJs+uAJIHFyiqOxDP9wzsGKuvTIf9X 3RLmaOI2fZF+Rk7PD7lln4RwK+XS+XzVBRt/RDa256Ap6Yqk396UBWDfu0bsru3fqh ChZZc6HZ8uRUmT4sTlRaVKnFURJIQI+o37YLNiCQ= To: libcamera-devel@lists.libcamera.org Date: Wed, 20 Dec 2023 16:31:43 +0000 Message-Id: <20231220163144.574787-1-dan.scally@ideasonboard.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH 1/2] 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 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. Signed-off-by: Daniel Scally Reviewed-by: Jacopo Mondi Reviewed-by: Laurent Pinchart --- 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