summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulian Murgia <the.straton@gmail.com>2017-06-14 15:48:50 +0200
committerJulian Murgia <the.straton@gmail.com>2017-06-14 15:48:50 +0200
commit9c7b4c82a7223fe390e475265553f1e88a93b87a (patch)
tree6c89044e3dc82eb673ffea5fc54b46d2405e536a
parentffe61e63d145b6e12a9f259259bb097777e7f1ae (diff)
Add Signals descriptions when they exist.
-rw-r--r--doc/tools/makemd.py6
-rw-r--r--doc/tools/makerst.py6
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/tools/makemd.py b/doc/tools/makemd.py
index bd0d4c6819..b2444eb47b 100644
--- a/doc/tools/makemd.py
+++ b/doc/tools/makemd.py
@@ -273,6 +273,12 @@ def make_doku_class(node):
f.write('\n### Signals \n')
for m in list(events):
make_method(f, node.attrib['name'], m, True, True)
+ d = m.find('description')
+ if d == None or d.text.strip() == '':
+ continue
+ f.write('\n')
+ f.write(dokuize_text(d.text.strip()))
+ f.write('\n')
members = node.find('members')
diff --git a/doc/tools/makerst.py b/doc/tools/makerst.py
index 6b6780ce1e..8a117f6450 100644
--- a/doc/tools/makerst.py
+++ b/doc/tools/makerst.py
@@ -441,6 +441,12 @@ def make_rst_class(node):
f.write(make_heading('Signals', '-'))
for m in list(events):
make_method(f, node.attrib['name'], m, True, name, True)
+ d = m.find('description')
+ if d == None or d.text.strip() == '':
+ continue
+ f.write(rstize_text(d.text.strip(), name))
+ f.write("\n\n")
+
f.write('\n')
members = node.find('members')