{"id":1599,"url":"https://patchwork.libcamera.org/api/patches/1599/?format=json","web_url":"https://patchwork.libcamera.org/patch/1599/","project":{"id":1,"url":"https://patchwork.libcamera.org/api/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":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","date":"2019-07-03T21:13:58","name":"[libcamera-devel] utils: checkstyle.py: Add Doxygen formatter","commit_ref":"91a65e9ee655d7919972cb50811b417c97be95a5","pull_url":null,"state":"accepted","archived":false,"hash":"f7b25c1d033a1a66900c33bd10f334f8216775f5","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/?format=json","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"delegate":null,"mbox":"https://patchwork.libcamera.org/patch/1599/mbox/","series":[{"id":395,"url":"https://patchwork.libcamera.org/api/series/395/?format=json","web_url":"https://patchwork.libcamera.org/project/libcamera/list/?series=395","date":"2019-07-03T21:13:58","name":"[libcamera-devel] utils: checkstyle.py: Add Doxygen formatter","version":1,"mbox":"https://patchwork.libcamera.org/series/395/mbox/"}],"comments":"https://patchwork.libcamera.org/api/patches/1599/comments/","check":"pending","checks":"https://patchwork.libcamera.org/api/patches/1599/checks/","tags":{},"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 36C2D60C01\n\tfor ;\n\tWed, 3 Jul 2019 23:14:24 +0200 (CEST)","from pendragon.bb.dnainternet.fi\n\t(dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id AC93324B\n\tfor ;\n\tWed, 3 Jul 2019 23:14:23 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1562188463;\n\tbh=B+Ksoj8SlgFZD/J4Fr60MOg75vBeN1fAVUHYNZa7S68=;\n\th=From:To:Subject:Date:From;\n\tb=mGmIRG7tYe5BuWiZjVsHpnrnbPIyEyUNRuz0IDRTKv2DuwpuErUdEupaKp7crfP2p\n\tuh8hHE+0kojquHk5KDBPIK+VeZaqgn6XY3V6FrONoygtSppikkDhz0rlsMLcdJkrP2\n\tLR0LZuYLSiVkJbTUiaubWDfbwsavxY/TOGF5TIlo=","From":"Laurent Pinchart ","To":"libcamera-devel@lists.libcamera.org","Date":"Thu, 4 Jul 2019 00:13:58 +0300","Message-Id":"<20190703211358.2362-1-laurent.pinchart@ideasonboard.com>","X-Mailer":"git-send-email 2.21.0","MIME-Version":"1.0","Content-Transfer-Encoding":"8bit","Subject":"[libcamera-devel] [PATCH] utils: checkstyle.py: Add Doxygen\n\tformatter","X-BeenThere":"libcamera-devel@lists.libcamera.org","X-Mailman-Version":"2.1.23","Precedence":"list","List-Id":"","List-Unsubscribe":",\n\t","List-Archive":"","List-Post":"","List-Help":"","List-Subscribe":",\n\t","X-List-Received-Date":"Wed, 03 Jul 2019 21:14:24 -0000"},"content":"Add a formatter for doxygen comments. In its initial implementation the\nformatter ensures that the first word of a \\return statement starts with\nan uppercase letter.\n\nSigned-off-by: Laurent Pinchart \n---\n utils/checkstyle.py | 28 ++++++++++++++++++++++++++++\n 1 file changed, 28 insertions(+)","diff":"diff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex bc631d405007..fab4b116d2ff 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -350,6 +350,34 @@ class CLangFormatter(Formatter):\n return ret.stdout.decode('utf-8')\n \n \n+class DoxygenFormatter(Formatter):\n+ patterns = ('*.c', '*.cpp')\n+\n+ return_regex = re.compile(' +\\\\* +\\\\\\\\return +[a-z]')\n+\n+ @classmethod\n+ def format(cls, filename, data):\n+ lines = []\n+ in_doxygen = False\n+\n+ for line in data.split('\\n'):\n+ if line.find('/**') != -1:\n+ in_doxygen = True\n+\n+ if not in_doxygen:\n+ lines.append(line)\n+ continue\n+\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+ in_doxygen = False\n+\n+ lines.append(line)\n+\n+ return '\\n'.join(lines)\n+\n+\n class StripTrailingSpaceFormatter(Formatter):\n patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')\n \n","prefixes":["libcamera-devel"]}