summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2019-07-03 23:53:01 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2019-07-04 14:58:11 +0300
commit91a65e9ee655d7919972cb50811b417c97be95a5 (patch)
tree6a19d7c206c171252545bb3b9d53ea5cf0be50ae
parent79e03cdf40f9ef97751b9a9aa1bcb6d3df6234f2 (diff)
utils: checkstyle.py: Add Doxygen formatter
Add a formatter for doxygen comments. In its initial implementation the formatter ensures that the first word of a \return statement starts with an uppercase letter. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rwxr-xr-xutils/checkstyle.py28
1 files changed, 28 insertions, 0 deletions
diff --git a/utils/checkstyle.py b/utils/checkstyle.py
index bc631d40..fab4b116 100755
--- a/utils/checkstyle.py
+++ b/utils/checkstyle.py
@@ -350,6 +350,34 @@ class CLangFormatter(Formatter):
return ret.stdout.decode('utf-8')
+class DoxygenFormatter(Formatter):
+ patterns = ('*.c', '*.cpp')
+
+ return_regex = re.compile(' +\\* +\\\\return +[a-z]')
+
+ @classmethod
+ def format(cls, filename, data):
+ lines = []
+ in_doxygen = False
+
+ for line in data.split('\n'):
+ if line.find('/**') != -1:
+ in_doxygen = True
+
+ if not in_doxygen:
+ lines.append(line)
+ continue
+
+ line = cls.return_regex.sub(lambda m: m.group(0)[:-1] + m.group(0)[-1].upper(), line)
+
+ if line.find('*/') != -1:
+ in_doxygen = False
+
+ lines.append(line)
+
+ return '\n'.join(lines)
+
+
class StripTrailingSpaceFormatter(Formatter):
patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')