From 7d79e9425e258413a523cc2fd124a6ec16839d2a Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Tue, 16 Apr 2024 13:09:17 +0300 Subject: utils: checkstyle.py: Drop period at end of Doxygen one liners The libcamera documentation style calls for no period at the end of the Doxygen one-liner commands (\brief, \param and \return). Extend the DoxygenFormatter class to drop the period. Signed-off-by: Laurent Pinchart Reviewed-by: Kieran Bingham --- utils/checkstyle.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/utils/checkstyle.py b/utils/checkstyle.py index 2ab7e50f..88078a61 100755 --- a/utils/checkstyle.py +++ b/utils/checkstyle.py @@ -753,6 +753,7 @@ class CLangFormatter(Formatter): class DoxygenFormatter(Formatter): patterns = ('*.c', '*.cpp') + oneliner_regex = re.compile(r'^ +\* +\\(brief|param|return)\b.*\.$') return_regex = re.compile(r' +\* +\\return +[a-z]') @classmethod @@ -768,6 +769,7 @@ class DoxygenFormatter(Formatter): lines.append(line) continue + line = cls.oneliner_regex.sub(lambda m: m.group(0)[:-1], line) line = cls.return_regex.sub(lambda m: m.group(0)[:-1] + m.group(0)[-1].upper(), line) if line.find('*/') != -1: -- cgit v1.2.1