BLAHAJ
/
libsigrok
10
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

bindings: Transfer C++ method parameter documentation to Python/Java bindings.

This commit is contained in:
Martin Ling 2014-08-01 20:08:44 +01:00 committed by Uwe Hermann
parent b6f411ac4e
commit 5cad31c708
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
bindings/swig/doc.py
View File

@ -50,10 +50,26 @@ for compound in index.findall('compound'):
for function in section.findall('memberdef'): for function in section.findall('memberdef'):
function_name = function.find('name').text function_name = function.find('name').text
brief = get_text(function.find('briefdescription')) brief = get_text(function.find('briefdescription'))
parameters = {}
for para in function.find('detaileddescription').findall('para'):
paramlist = para.find('parameterlist')
if paramlist is not None:
for param in paramlist.findall('parameteritem'):
namelist = param.find('parameternamelist')
name = namelist.find('parametername').text
description = get_text(param.find('parameterdescription'))
if description:
parameters[name] = description
if brief: if brief:
if language == 'python': if language == 'python':
print '%%feature("docstring") %s::%s "%s";' % ( print str.join('\n', [
class_name, function_name, brief) '%%feature("docstring") %s::%s "%s' % (
class_name, function_name, brief)] + [
'@param %s %s' % (name, desc)
for name, desc in parameters.items()]) + '";'
elif language == 'java': elif language == 'java':
print '%%javamethodmodifiers %s::%s "/** %s */\npublic"' % ( print str.join('\n', [
class_name, function_name, brief) '%%javamethodmodifiers %s::%s "/** %s' % (
class_name, function_name, brief)] + [
' * @param %s %s' % (name, desc)
for name, desc in parameters.items()]) + ' */\npublic"'