{"id":19890,"url":"https://patchwork.libcamera.org/api/1.1/patches/19890/?format=json","web_url":"https://patchwork.libcamera.org/patch/19890/","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":"<20240416102004.10617-3-laurent.pinchart@ideasonboard.com>","date":"2024-04-16T10:20:04","name":"[2/2] utils: checkstyle.py: Drop period at end of Doxygen one liners","commit_ref":"7d79e9425e258413a523cc2fd124a6ec16839d2a","pull_url":null,"state":"accepted","archived":false,"hash":"8e1da7ae1547bb57ef43f10733008ddf2db56733","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/1.1/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/19890/mbox/","series":[{"id":4258,"url":"https://patchwork.libcamera.org/api/1.1/series/4258/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=4258","date":"2024-04-16T10:20:02","name":"utils: checkstyle.py: Extend Doxygen formatter","version":1,"mbox":"https://patchwork.libcamera.org/series/4258/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/19890/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/19890/checks/","tags":{},"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 7EF06BE08B\n\tfor ;\n\tTue, 16 Apr 2024 10:20:22 +0000 (UTC)","from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id 284FB63352;\n\tTue, 16 Apr 2024 12:20:22 +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 EA36C6333E\n\tfor ;\n\tTue, 16 Apr 2024 12:20:18 +0200 (CEST)","from pendragon.ideasonboard.com (85-76-7-196-nat.elisa-mobile.fi\n\t[85.76.7.196])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 5B8AE512\n\tfor ;\n\tTue, 16 Apr 2024 12:19:32 +0200 (CEST)"],"Authentication-Results":"lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"miRhFwnR\"; dkim-atps=neutral","DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1713262772;\n\tbh=lLZVedF9/SIqTSWmIXEJOPXTcRAyvwiTA8KlSFa+sfs=;\n\th=From:To:Subject:Date:In-Reply-To:References:From;\n\tb=miRhFwnRyAeKqKwefhRSm0iHSi01U22B9ALWgQPeBsP/X7rGi+3aexgdfsFEPd2Mj\n\tMyxFbmEDIePjmzC5H/0l9RMnhAM0LXy68CiSCy/3NuICw6ZCiBTD8XOPOE7q1ISeVc\n\tonNDaOYCUZkqXWbFCYzdaGcX/l5ehQ7LLXuaZvAs=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Subject":"[PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen one\n\tliners","Date":"Tue, 16 Apr 2024 13:20:04 +0300","Message-ID":"<20240416102004.10617-3-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.43.2","In-Reply-To":"<20240416102004.10617-1-laurent.pinchart@ideasonboard.com>","References":"<20240416102004.10617-1-laurent.pinchart@ideasonboard.com>","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","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","Errors-To":"libcamera-devel-bounces@lists.libcamera.org","Sender":"\"libcamera-devel\" "},"content":"The libcamera documentation style calls for no period at the end of the\nDoxygen one-liner commands (\\brief, \\param and \\return). Extend the\nDoxygenFormatter class to drop the period.\n\nSigned-off-by: Laurent Pinchart \n---\n utils/checkstyle.py | 2 ++\n 1 file changed, 2 insertions(+)","diff":"diff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex 2ab7e50fb0b6..88078a6171b7 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -753,6 +753,7 @@ class CLangFormatter(Formatter):\n class DoxygenFormatter(Formatter):\n patterns = ('*.c', '*.cpp')\n \n+ oneliner_regex = re.compile(r'^ +\\* +\\\\(brief|param|return)\\b.*\\.$')\n return_regex = re.compile(r' +\\* +\\\\return +[a-z]')\n \n @classmethod\n@@ -768,6 +769,7 @@ class DoxygenFormatter(Formatter):\n lines.append(line)\n continue\n \n+ line = cls.oneliner_regex.sub(lambda m: m.group(0)[:-1], line)\n line = cls.return_regex.sub(lambda m: m.group(0)[:-1] + m.group(0)[-1].upper(), line)\n \n if line.find('*/') != -1:\n","prefixes":["2/2"]}