summaryrefslogtreecommitdiffstats
path: root/utils
diff options
context:
space:
mode:
authorNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-20 00:17:59 +0200
committerNeels Hofmeyr <nhofmeyr@sysmocom.de>2017-06-23 00:18:22 +0000
commit87e4550585c643e97e0003119b254251ac5ed1d4 (patch)
tree9287f66aba70e9253f4d62926c54dddeb492895e /utils
parent249fb71a2e124acb191b7cd4d2c3af6a45da4a5e (diff)
doxygen: enable AUTOBRIEF, drop \brief
Especially for short descriptions, it is annoying to have to type \brief for every single API doc. Drop all \brief and enable the AUTOBRIEF feature of doxygen, which always takes the first sentence of an API doc as the brief description. Change-Id: I11a8a821b065a128108641a2a63fb5a2b1916e87
Diffstat (limited to 'utils')
-rw-r--r--utils/conv_gen.py3
1 files changed, 1 insertions, 2 deletions
diff --git a/utils/conv_gen.py b/utils/conv_gen.py
index 0cdba756..6b6b2677 100644
--- a/utils/conv_gen.py
+++ b/utils/conv_gen.py
@@ -170,8 +170,7 @@ class ConvolutionalCode(object):
def print_description(self, fi, brief = False):
if brief is True:
- fi.write("/*! \\brief ")
- fi.write("structure describing %s\n"
+ fi.write("/*! structure describing %s.\n"
% self.description[0])
for line in self.description[1:]:
fi.write(" * %s\n" % line)