[{"id":3652,"web_url":"https://patchwork.libcamera.org/comment/3652/","msgid":"<20200211111105.GD28355@pendragon.ideasonboard.com>","date":"2020-02-11T11:11:05","subject":"Re: [libcamera-devel] [PATCH] libcamera: Standardize on doxygen\n\t\\return","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nThank you for the patch.\n\nOn Tue, Feb 11, 2020 at 11:10:11AM +0000, Kieran Bingham wrote:\n> Two occasions in the source utilise the Doxygen '\\returns' alias for \\return.\n> We use \\return everywhere else in the code. Update the two occurences to match.\n> \n> Signed-off-by: Kieran Bingham \n\nReviewed-by: Laurent Pinchart \n\n> ---\n> src/libcamera/geometry.cpp | 2 +-\n> src/libcamera/utils.cpp | 2 +-\n> 2 files changed, 2 insertions(+), 2 deletions(-)\n> \n> diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp\n> index 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> {\n> diff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp\n> index 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)","headers":{"Return-Path":"","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id CCB786043D\n\tfor ;\n\tTue, 11 Feb 2020 12:11:19 +0100 (CET)","from pendragon.ideasonboard.com (81-175-216-236.bb.dnainternet.fi\n\t[81.175.216.236])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5B0EC52A;\n\tTue, 11 Feb 2020 12:11:19 +0100 (CET)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1581419479;\n\tbh=hiY1ixyKq+XZvqkpfRD25+JQshMr4m60X6AbFyJhz4M=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=U8U29IbaDhmIL9opTc5gdRCj184oBIPnpMP78lfBtpz+K2HN95pFuQoP6SqPMtm0s\n\taB2hcROyNQFdUgAfQJzhbeimCNtuWuyxB3jD27L15dFUEON3pY28YfVQ8BevXo3Z9t\n\tlz23x67UbQoQU1L/QLrDO8dBDIHvZpR+oxBX7yFM=","Date":"Tue, 11 Feb 2020 13:11:05 +0200","From":"Laurent Pinchart ","To":"Kieran Bingham ","Cc":"LibCamera Devel ","Message-ID":"<20200211111105.GD28355@pendragon.ideasonboard.com>","References":"<20200211111011.18499-1-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20200211111011.18499-1-kieran.bingham@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH] libcamera: Standardize on doxygen\n\t\\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:11:20 -0000"}}]