From patchwork Tue Feb 11 11:10:11 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Kieran Bingham X-Patchwork-Id: 2803 Return-Path: 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 90ADA6043D for ; Tue, 11 Feb 2020 12:10:15 +0100 (CET) Received: from localhost.localdomain (cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233]) by perceval.ideasonboard.com (Postfix) with ESMTPSA id 10C2B52A; Tue, 11 Feb 2020 12:10:15 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com; s=mail; t=1581419415; bh=dFox3JdsI8s0pBZMf4sHLuZi00NhoeMXNR9WLE50wL4=; h=From:To:Cc:Subject:Date:From; b=lY8cWRVh1ZHrje1fbL5KYiM84FWeLGNt98EGUtUMpxM+DFp9A6CR4AKJSakhfQ1DR 69fHSdSBILR5LvtzlP9KyV4i5dv8+o0VbdnZekCM/TKyNbhYDCvAA7RzwfdUJep+Xa AhbW5y3v/VlnT6VVbbFkdVFhe3BOyPDdwYIKmLaQ= From: Kieran Bingham To: LibCamera Devel Date: Tue, 11 Feb 2020 11:10:11 +0000 Message-Id: <20200211111011.18499-1-kieran.bingham@ideasonboard.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Subject: [libcamera-devel] [PATCH] libcamera: Standardize on doxygen \return 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-List-Received-Date: Tue, 11 Feb 2020 11:10:15 -0000 Two occasions in the source utilise the Doxygen '\returns' alias for \return. We use \return everywhere else in the code. Update the two occurences to match. Signed-off-by: Kieran Bingham Reviewed-by: Laurent Pinchart --- src/libcamera/geometry.cpp | 2 +- src/libcamera/utils.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index 32b0faeadc63..92c53f64a58b 100644 --- a/src/libcamera/geometry.cpp +++ b/src/libcamera/geometry.cpp @@ -269,7 +269,7 @@ bool operator<(const Size &lhs, const Size &rhs) /** * \brief Test if a size is contained in the range * \param[in] size Size to check - * \returns True if \a size is contained in the range + * \return True if \a size is contained in the range */ bool SizeRange::contains(const Size &size) const { diff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp index fc6a174d80f2..f5d4b10f34b5 100644 --- a/src/libcamera/utils.cpp +++ b/src/libcamera/utils.cpp @@ -57,7 +57,7 @@ const char *basename(const char *path) * avoid vulnerabilities that could occur if set-user-ID or set-group-ID * programs accidentally trust the environment. * - * \returns A pointer to the value in the environment or NULL if the requested + * \return A pointer to the value in the environment or NULL if the requested * environment variable doesn't exist or if secure execution is required. */ char *secure_getenv(const char *name)