maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge pull request #9173 from StraToN/signal-descriptions

Browse source 
[master] Add Signals descriptions when they exist.

[ci skip]
This commit is contained in:
Rémi Verschelde 2017-06-14 16:12:56 +02:00 committed by GitHub
parent ffe61e63d1 9c7b4c82a7
commit b21a1232ba
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/tools/makemd.py
View file

@ -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')

6
doc/tools/makerst.py
View file

@ -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')