mirrors/linphone-iphone
1
0
Fork 1
mirror of https://gitlab.linphone.org/BC/public/linphone-iphone.git synced 2026-02-02 11:19:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Handle links between methods in the Python module documentation.

Browse source
This commit is contained in:
Ghislain MARY 2014-12-15 16:37:46 +01:00
parent 5128769b00
commit 9e1b6e6956
2 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
tools/python/apixml2python/linphone.py
View file

@ -951,6 +951,7 @@ class LinphoneModule(object):
self.mslist_types = Set([])
self.enums = []
self.enum_names = []
self.cfunction2methodmap = {}
hand_written_functions = []
for hand_written_code in hand_written_codes:
hand_written_functions += hand_written_code.func_list
@ -1074,6 +1075,7 @@ class LinphoneModule(object):
m['method_name'] = method_name.replace(c['class_c_function_prefix'], '')
if method_name not in hand_written_functions:
m['method_xml_node'] = xml_type_method
self.cfunction2methodmap[method_name] = ':py:meth:`linphone.' + c['class_name'] + '.' + m['method_name'] + '`'
c['class_type_methods'].append(m)
c['class_instance_methods'] = []
xml_instance_methods = xml_class.findall("./instancemethods/instancemethod")
@ -1089,6 +1091,7 @@ class LinphoneModule(object):
m['method_name'] = method_name.replace(c['class_c_function_prefix'], '')
if method_name not in hand_written_functions:
m['method_xml_node'] = xml_instance_method
self.cfunction2methodmap[method_name] = ':py:meth:`linphone.' + c['class_name'] + '.' + m['method_name'] + '`'
c['class_instance_methods'].append(m)
c['class_properties'] = []
xml_properties = xml_class.findall("./properties/property")
@ -1115,6 +1118,7 @@ class LinphoneModule(object):
p['getter_reference'] = "(getter)pylinphone_" + c['class_name'] + "_" + p['getter_name']
p['getter_definition_begin'] = "static PyObject * pylinphone_" + c['class_name'] + "_" + p['getter_name'] + "(PyObject *self, void *closure) {"
p['getter_definition_end'] = "}"
self.cfunction2methodmap[xml_property_getter.get('name')] = ':py:attr:`linphone.' + c['class_name'] + '.' + property_name + '`'
else:
p['getter_reference'] = "NULL"
if xml_property_setter is not None:
@ -1124,6 +1128,7 @@ class LinphoneModule(object):
p['setter_reference'] = "(setter)pylinphone_" + c['class_name'] + "_" + p['setter_name']
p['setter_definition_begin'] = "static int pylinphone_" + c['class_name'] + "_" + p['setter_name'] + "(PyObject *self, PyObject *value, void *closure) {"
p['setter_definition_end'] = "}"
self.cfunction2methodmap[xml_property_setter.get('name')] = ':py:attr:`linphone.' + c['class_name'] + '.' + property_name + '`'
else:
p['setter_reference'] = "NULL"
c['class_properties'].append(p)
@ -1243,8 +1248,16 @@ class LinphoneModule(object):
def __replace_doc_special_chars(self, doc):
return doc.replace('"', '').encode('string-escape')
def __replace_doc_cfunction_by_method(self, doc):
for cfunction, method in self.cfunction2methodmap.iteritems():
doc = doc.replace(cfunction + '()', method)
for cfunction, method in self.cfunction2methodmap.iteritems():
doc = doc.replace(cfunction, method)
return doc
def __format_doc(self, brief_description, detailed_description):
doc = self.__format_doc_content(brief_description, detailed_description)
doc = self.__replace_doc_cfunction_by_method(doc)
doc = self.__replace_doc_special_chars(doc)
return doc
@ -1277,6 +1290,7 @@ class LinphoneModule(object):
return_argument_type = ArgumentType(return_type, return_complete_type, return_contained_type, self)
doc += '\n:returns: ' + return_doc
doc += '\n:rtype: ' + return_argument_type.type_str
doc = self.__replace_doc_cfunction_by_method(doc)
doc = self.__replace_doc_special_chars(doc)
return doc
@ -1288,6 +1302,7 @@ class LinphoneModule(object):
argument_type = ArgumentType(arg_type, arg_complete_type, arg_contained_type, self)
doc = self.__format_doc_content(xml_node.find('briefdescription'), xml_node.find('detaileddescription'))
doc = '[' + argument_type.type_str + '] ' + doc
doc = self.__replace_doc_cfunction_by_method(doc)
doc = self.__replace_doc_special_chars(doc)
return doc
@ -1299,5 +1314,6 @@ class LinphoneModule(object):
return_argument_type = ArgumentType(return_type, return_complete_type, return_contained_type, self)
doc = self.__format_doc_content(xml_node.find('briefdescription'), xml_node.find('detaileddescription'))
doc = '[' + return_argument_type.type_str + '] ' + doc
doc = self.__replace_doc_cfunction_by_method(doc)
doc = self.__replace_doc_special_chars(doc)
return doc

2
tools/python/apixml2python/linphone_module.mustache
View file

@ -313,7 +313,7 @@ PyMODINIT_FUNC initlinphone(void) {
{{/enum_deprecated_values}}
{{/enums}}
menum = Py_InitModule3("PayloadTypeType", pylinphone_PayloadTypeType_ModuleMethods, "Type of linphone.PayloadType.\n\n.. csv-table::\n :delim: |\n :header: Value,Description\n\n AudioContinuous|\n AudioPacketized|\n Video|\n Text|\n Other|\n");
menum = Py_InitModule3("PayloadTypeType", pylinphone_PayloadTypeType_ModuleMethods, "Type of :py:class:`linphone.PayloadType`.\n\n.. csv-table::\n :delim: |\n :header: Value,Description\n\n AudioContinuous|\n AudioPacketized|\n Video|\n Text|\n Other|\n");
if (menum == NULL) return;
Py_INCREF(menum);
if (PyModule_AddObject(m, "PayloadTypeType", menum) < 0) return;