Browse Source

Add Signals descriptions when they exist.

Julian Murgia 8 years ago
parent
commit
9c7b4c82a7
2 changed files with 12 additions and 0 deletions
  1. 6 0
      doc/tools/makemd.py
  2. 6 0
      doc/tools/makerst.py

+ 6 - 0
doc/tools/makemd.py

@@ -273,6 +273,12 @@ def make_doku_class(node):
         f.write('\n###  Signals  \n')
         f.write('\n###  Signals  \n')
         for m in list(events):
         for m in list(events):
             make_method(f, node.attrib['name'], m, True, True)
             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')
     members = node.find('members')
 
 

+ 6 - 0
doc/tools/makerst.py

@@ -441,6 +441,12 @@ def make_rst_class(node):
         f.write(make_heading('Signals', '-'))
         f.write(make_heading('Signals', '-'))
         for m in list(events):
         for m in list(events):
             make_method(f, node.attrib['name'], m, True, name, True)
             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')
         f.write('\n')
 
 
     members = node.find('members')
     members = node.find('members')