[PATCH 2/2] utils: checkstyle.py: Drop period at end of Doxygen one liners
Laurent Pinchart
laurent.pinchart at ideasonboard.com
Tue Apr 16 12:20:04 CEST 2024
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 <laurent.pinchart at ideasonboard.com>
---
utils/checkstyle.py | 2 ++
1 file changed, 2 insertions(+)
diff --git a/utils/checkstyle.py b/utils/checkstyle.py
index 2ab7e50fb0b6..88078a6171b7 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:
--
Regards,
Laurent Pinchart
More information about the libcamera-devel
mailing list