{"id":2803,"url":"https://patchwork.libcamera.org/api/1.1/patches/2803/?format=json","web_url":"https://patchwork.libcamera.org/patch/2803/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/1.1/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":"<20200211111011.18499-1-kieran.bingham@ideasonboard.com>","date":"2020-02-11T11:10:11","name":"[libcamera-devel] libcamera: Standardize on doxygen \\return","commit_ref":"5dc5fb2ac57ec7123215c82d10992cfbcddf34e9","pull_url":null,"state":"accepted","archived":false,"hash":"913fde4f88c732422b3cb564ca3f68d21ccdc364","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/1.1/people/4/?format=json","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/2803/mbox/","series":[{"id":667,"url":"https://patchwork.libcamera.org/api/1.1/series/667/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=667","date":"2020-02-11T11:10:11","name":"[libcamera-devel] libcamera: Standardize on doxygen \\return","version":1,"mbox":"https://patchwork.libcamera.org/series/667/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/2803/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/2803/checks/","tags":{},"headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 90ADA6043D\n\tfor ;\n\tTue, 11 Feb 2020 12:10:15 +0100 (CET)","from localhost.localdomain\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 10C2B52A;\n\tTue, 11 Feb 2020 12:10:15 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1581419415;\n\tbh=dFox3JdsI8s0pBZMf4sHLuZi00NhoeMXNR9WLE50wL4=;\n\th=From:To:Cc:Subject:Date:From;\n\tb=lY8cWRVh1ZHrje1fbL5KYiM84FWeLGNt98EGUtUMpxM+DFp9A6CR4AKJSakhfQ1DR\n\t69fHSdSBILR5LvtzlP9KyV4i5dv8+o0VbdnZekCM/TKyNbhYDCvAA7RzwfdUJep+Xa\n\tAhbW5y3v/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","Content-Transfer-Encoding":"8bit","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":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Tue, 11 Feb 2020 11:10:15 -0000"},"content":"Two occasions in the source utilise the Doxygen '\\returns' alias for \\return.\nWe use \\return everywhere else in the code. Update the two occurences to match.\n\nSigned-off-by: Kieran Bingham \n---\n src/libcamera/geometry.cpp | 2 +-\n src/libcamera/utils.cpp | 2 +-\n 2 files changed, 2 insertions(+), 2 deletions(-)","diff":"diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp\nindex 32b0faeadc63..92c53f64a58b 100644\n--- a/src/libcamera/geometry.cpp\n+++ b/src/libcamera/geometry.cpp\n@@ -269,7 +269,7 @@ bool operator<(const Size &lhs, const Size &rhs)\n /**\n * \\brief Test if a size is contained in the range\n * \\param[in] size Size to check\n- * \\returns True if \\a size is contained in the range\n+ * \\return True if \\a size is contained in the range\n */\n bool SizeRange::contains(const Size &size) const\n {\ndiff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp\nindex fc6a174d80f2..f5d4b10f34b5 100644\n--- a/src/libcamera/utils.cpp\n+++ b/src/libcamera/utils.cpp\n@@ -57,7 +57,7 @@ const char *basename(const char *path)\n * avoid vulnerabilities that could occur if set-user-ID or set-group-ID\n * programs accidentally trust the environment.\n *\n- * \\returns A pointer to the value in the environment or NULL if the requested\n+ * \\return A pointer to the value in the environment or NULL if the requested\n * environment variable doesn't exist or if secure execution is required.\n */\n char *secure_getenv(const char *name)\n","prefixes":["libcamera-devel"]}