[{"id":24838,"web_url":"https://patchwork.libcamera.org/comment/24838/","msgid":"","date":"2022-08-30T10:54:25","subject":"Re: [libcamera-devel] [PATCH] libcamera: request: Fix doxygen\n\twarning","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Umang,\n\nThank you for the patch.\n\nOn Tue, Aug 30, 2022 at 02:44:20PM +0530, Umang Jain via libcamera-devel wrote:\n> Request::Private::reuse() uses \\copydoc for its documentation being\n> copied from Request::reuse(). However, both of these functions\n> differs in function parameters aspect which causes doxygen to put out\n> a warning:\n> \n> libcamera::Request::Private::reuse has @param documentation sections but no arguments\n\nI've justed updated doxygen and can indeed reproduce the problem.\n\n> Currently doxygen has no helper section tag (like \\copydetails) which\n> can omit the \\params and just the copy the body. So for now, copy the\n> brief only with \\copybrief to silence the warning.\n> \n> Signed-off-by: Umang Jain \n> ---\n> src/libcamera/request.cpp | 2 +-\n> 1 file changed, 1 insertion(+), 1 deletion(-)\n> \n> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp\n> index d2af1d22..42aa8483 100644\n> --- a/src/libcamera/request.cpp\n> +++ b/src/libcamera/request.cpp\n> @@ -158,7 +158,7 @@ void Request::Private::cancel()\n> }\n> \n> /**\n> - * \\copydoc Request::reuse()\n> + * \\copybrief Request::reuse()\n> */\n\nThe Request::reuse() and Request::Private::reuse() functions are\ndifferent, the latter only resets the request but doesn't reuse\nanything. How about using this as an opportunity to improve the code, by\nrenaming the function to reset() ? It could be documented as\n\n/**\n * \\brief Reset the request internal data to default values\n *\n * After calling this function, all request internal data will have default\n * values as if the Request::Private instance had just been constructed.\n */\n\nThe commit message needs a bit of an update.\n\nReviewed-by: Laurent Pinchart \n\n> void Request::Private::reuse()\n> {","headers":{"Return-Path":"","X-Original-To":"parsemail@patchwork.libcamera.org","Delivered-To":"parsemail@patchwork.libcamera.org","Received":["from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 9F115C3272\n\tfor ;\n\tTue, 30 Aug 2022 10:54:37 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 0838161FBD;\n\tTue, 30 Aug 2022 12:54:37 +0200 (CEST)","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 226F961F9C\n\tfor ;\n\tTue, 30 Aug 2022 12:54:36 +0200 (CEST)","from pendragon.ideasonboard.com (62-78-145-57.bb.dnainternet.fi\n\t[62.78.145.57])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 76B79481;\n\tTue, 30 Aug 2022 12:54:35 +0200 (CEST)"],"DKIM-Signature":["v=1; a=rsa-sha256; c=relaxed/simple; d=libcamera.org;\n\ts=mail; t=1661856877;\n\tbh=u7I/gDjlrj+bJ4m5gqVTUxuYeyhUsEErTK/ZTnoxtng=;\n\th=Date:To:References:In-Reply-To:Subject:List-Id:List-Unsubscribe:\n\tList-Archive:List-Post:List-Help:List-Subscribe:From:Reply-To:Cc:\n\tFrom;\n\tb=YPgJzFYxiRYS8I+QyLqR2PPD0AiSvHAiErGs2fWUvoUq7pdd3HSHTfxsTSEKkuJGJ\n\tvR7mQ2xhe7DDES50uHZWxdqqWZkotBeXwpDPZQcESa0QHCwwAk1Y2JIp1FnrKLrEHC\n\tm8iTipQs/y7IYomCAYPGpR6SBjQG4mAM+RfX6U07AhPYRPWPMJbLXQ6ea5QXHMv+SY\n\tYJNHy8vOZ0R5koGhcl8XgWDsiL1YgydsSh7IuXUGlvgGA9fKhWvuoMXNHJ/conI4TY\n\txdkY8PoREYlubyYnNvR53svA0EVm5IdZphUAunjrwv3Ij+uQblt3qjP/1Kdxr8XHej\n\tbNzyGUdxvOxFg==","v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1661856875;\n\tbh=u7I/gDjlrj+bJ4m5gqVTUxuYeyhUsEErTK/ZTnoxtng=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=AQwcer60ikzAD5TTTb4dxGlKHbE/c/7BAjswK50ub00Db5AQR1m28T4RJiXhf+R4z\n\tsmA5Fy5EyzLofU6cRleUYSd9tpWra6Nrx6EJFmAo+rFwiXvWlQQrA1WvAaOQlxjug6\n\tQN0Qxvl/fu4EG1EY+eaIic2cG76rC3+TgLzfGFIQ="],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key; \n\tunprotected) header.d=ideasonboard.com\n\theader.i=@ideasonboard.com\n\theader.b=\"AQwcer60\"; dkim-atps=neutral","Date":"Tue, 30 Aug 2022 13:54:25 +0300","To":"Umang Jain ","Message-ID":"","References":"<20220830091420.1094813-1-umang.jain@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20220830091420.1094813-1-umang.jain@ideasonboard.com>","Subject":"Re: [libcamera-devel] [PATCH] libcamera: request: Fix doxygen\n\twarning","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","From":"Laurent Pinchart via libcamera-devel\n\t","Reply-To":"Laurent Pinchart ","Cc":"libcamera-devel@lists.libcamera.org","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "}}]