def format_doc(packet, shift_right): text = common.select_lang(packet.get_doc()[1]) parameter = { 'en': 'parameter', 'de': 'Parameter' } parameters = { 'en': 'parameters', 'de': 'Parameter' } link = ':csharp:func:`{2}() <{0}{1}::{2}>`' cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) name = other_packet.get_camel_case_name() name_right = link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, shift_right)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) parameter = { 'en': 'response value', 'de': 'Rückgabewert' } parameters = { 'en': 'response values', 'de': 'Rückgabewerte' } cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name_upper = other_packet.get_upper_case_name() name_right = ':tcpip:func:`CALLBACK_{1} <{0}.CALLBACK_{1}>`'.format(cls, name_upper) else: name_right = ':tcpip:func:`{1} <{0}.{1}>`'.format(cls, other_packet.get_underscore_name()) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, 1)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) parameter = { 'en': 'parameter', 'de': 'Parameter' } parameters = { 'en': 'parameters', 'de': 'Parameter' } for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name_upper = other_packet.get_upper_case_name() pre_upper = device.get_upper_case_name() name_right = ':c:data:`{0}_CALLBACK_{1}`'.format(pre_upper, name_upper) else: name_right = ':c:func:`{0}_{1}`'.format(device.get_underscore_name(), other_packet.get_underscore_name()) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, 1)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) parameter = { 'en': 'parameter', 'de': 'Parameter' } parameters = { 'en': 'parameters', 'de': 'Parameter' } cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name_upper = other_packet.get_upper_case_name() name_right = ':py:attr:`CALLBACK_{1} <{0}.CALLBACK_{1}>`'.format(cls, name_upper) else: name_right = ':py:func:`{1}() <{0}.{1}>`'.format(cls, other_packet.get_underscore_name()) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = common.handle_rst_if(text, device) text = common.handle_constants(text, device.get_category() + device.get_camel_case_name() + '.', packet) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, 1)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) parameter = { 'en': 'parameter', 'de': 'Parameter' } parameters = { 'en': 'parameters', 'de': 'Parameter' } cls = device.get_category() + device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) name = other_packet.get_camel_case_name() if other_packet.get_type() == 'callback': name_right = ':delphi:func:`On{1} <T{0}.On{1}>`'.format(cls, name) else: name_right = ':delphi:func:`{1} <T{0}.{1}>`'.format(cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = common.handle_rst_if(text, device) prefix = '{0}_{1}_'.format(device.get_category().upper(), device.get_upper_case_name()) text = common.handle_constants(text, prefix, packet) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, 1)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) link = '{{@link {0}{1}#{2}({3})}}' link_c = '{{@link {0}{1}.{2}Listener}}' # handle tables lines = text.split('\n') replaced_lines = [] in_table_head = False in_table_body = False for line in lines: if line.strip() == '.. csv-table::': in_table_head = True replaced_lines.append('\\verbatim') elif line.strip().startswith(':header: ') and in_table_head: replaced_lines.append(line[len(':header: '):]) elif line.strip().startswith(':widths:') and in_table_head: pass elif len(line.strip()) == 0 and in_table_head: in_table_head = False in_table_body = True replaced_lines.append('') elif len(line.strip()) == 0 and in_table_body: in_table_body = False replaced_lines.append('\\endverbatim') replaced_lines.append('') else: replaced_lines.append(line) text = '\n'.join(replaced_lines) cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name = other_packet.get_camel_case_name() name_right = link_c.format(device.get_category(), cls, name) else: name = other_packet.get_headless_camel_case_name() name_right = link.format(device.get_category(), cls, name, java_common.make_parameter_list(other_packet, True)) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = text.replace('Callback ', 'Listener ') text = text.replace(' Callback', ' Listener') text = text.replace('callback ', 'listener ') text = text.replace(' callback', ' listener') text = text.replace('.. note::', '\\note') text = text.replace('.. warning::', '\\warning') text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n\t * '.join(text.strip().split('\n'))
def format_doc(packet, shift_right): text = common.select_lang(packet.get_doc()[1]) cb_link = ":java:func:`{2}Listener <{0}{1}.{2}Listener>`" fu_link = ":java:func:`{2}() <{0}{1}::{2}>`" parameter = {"en": "parameter", "de": "Parameter"} parameters = {"en": "parameters", "de": "Parameter"} cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ":func:`{0}`".format(other_packet.get_camel_case_name()) if other_packet.get_type() == "callback": name = other_packet.get_camel_case_name() name_right = cb_link.format(device.get_category(), cls, name) else: name = other_packet.get_headless_camel_case_name() name_right = fu_link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = text.replace("Callback ", "Listener ") text = text.replace(" Callback", " Listener") text = text.replace("callback ", "listener ") text = text.replace(" callback", " listener") text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, shift_right)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) link = '{{@link {0}_{1}}}' link_c = '{{@link {0}_CALLBACK_{1}}}' # handle tables lines = text.split('\n') replaced_lines = [] in_table_head = False in_table_body = False for line in lines: if line.strip() == '.. csv-table::': in_table_head = True replaced_lines.append('\\verbatim') elif line.strip().startswith(':header: ') and in_table_head: replaced_lines.append(line[len(':header: '):]) elif line.strip().startswith(':widths:') and in_table_head: pass elif len(line.strip()) == 0 and in_table_head: in_table_head = False in_table_body = True replaced_lines.append('') elif len(line.strip()) == 0 and in_table_body: in_table_body = False replaced_lines.append('\\endverbatim') replaced_lines.append('') else: replaced_lines.append(line) text = '\n'.join(replaced_lines) for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name = other_packet.get_upper_case_name() name_right = link_c.format(device.get_upper_case_name(), name) else: name = other_packet.get_underscore_name() name_right = link.format(device.get_underscore_name(), name) text = text.replace(name_false, name_right) if packet.get_type() == 'callback': plist = c_common.make_parameter_list(packet)[2:].replace('*ret_', '') text = 'Signature: \code void callback({0}) \endcode\n'.format(plist) + text text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = text.replace('.. note::', '\\note') text = text.replace('.. warning::', '\\warning') text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n * '.join(text.strip().split('\n'))
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n '.join(text.strip().split('\n'))
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) link = '{0}{1}#{2}' link_c = 'CALLBACK_{0}' # handle tables lines = text.split('\n') replaced_lines = [] in_table_head = False in_table_body = False for line in lines: if line.strip() == '.. csv-table::': in_table_head = True elif line.strip().startswith(':header: ') and in_table_head: replaced_lines.append(line[len(':header: '):]) elif line.strip().startswith(':widths:') and in_table_head: pass elif len(line.strip()) == 0 and in_table_head: in_table_head = False in_table_body = True replaced_lines.append('') elif len(line.strip()) == 0 and in_table_body: in_table_body = False replaced_lines.append('') else: replaced_lines.append(line) text = '\n'.join(replaced_lines) cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name = other_packet.get_upper_case_name() name_right = link_c.format(name) else: name = other_packet.get_underscore_name() name_right = link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n # '.join(text.strip().split('\n'))
def format_doc(packet, shift_right): text = common.select_lang(packet.get_doc()[1]) cb_link = ':java:func:`{2}Listener <{0}{1}.{2}Listener>`' fu_link = ':java:func:`{2}() <{0}{1}::{2}>`' parameter = { 'en': 'parameter', 'de': 'Parameter' } parameters = { 'en': 'parameters', 'de': 'Parameter' } cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name = other_packet.get_camel_case_name() name_right = cb_link.format(device.get_category(), cls, name) else: name = other_packet.get_headless_camel_case_name() name_right = fu_link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", common.select_lang(parameter)) text = text.replace(":word:`parameters`", common.select_lang(parameters)) text = text.replace('Callback ', 'Listener ') text = text.replace(' Callback', ' Listener') text = text.replace('callback ', 'listener ') text = text.replace(' callback', ' listener') text = common.handle_rst_if(text, device) text = common.handle_constants(text, device.get_category() + device.get_camel_case_name() + '.', packet) text = common.handle_since_firmware(text, device, packet) return common.shift_right(text, shift_right)
def format_doc(packet, suffix): text = common.select_lang(packet.get_doc()[1]) link = '{0}{1}::{2}()' link_c = '{0}{1}::CALLBACK_{2}' # handle notes and warnings lines = text.split('\n') replaced_lines = [] in_note = False in_warning = False in_table_head = False in_table_body = False for line in lines: if line.strip() == '.. note::': in_note = True replaced_lines.append('<note>') elif line.strip() == '.. warning::': in_warning = True replaced_lines.append('<warning>') elif len(line.strip()) == 0 and in_note: in_note = False replaced_lines.append('</note>') replaced_lines.append('') elif len(line.strip()) == 0 and in_warning: in_warning = False replaced_lines.append('</warning>') replaced_lines.append('') elif line.strip() == '.. csv-table::': in_table_head = True replaced_lines.append('<code>') elif line.strip().startswith(':header: ') and in_table_head: replaced_lines.append(line[len(':header: '):]) elif line.strip().startswith(':widths:') and in_table_head: pass elif len(line.strip()) == 0 and in_table_head: in_table_head = False in_table_body = True replaced_lines.append('') elif len(line.strip()) == 0 and in_table_body: in_table_body = False replaced_lines.append('</code>') replaced_lines.append('') else: replaced_lines.append(line) text = '\n'.join(replaced_lines) cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) if other_packet.get_type() == 'callback': name = other_packet.get_upper_case_name() name_right = link_c.format(device.get_category(), cls, name) else: name = other_packet.get_headless_camel_case_name() name_right = link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = text.replace('.. note::', '\\note') text = text.replace('.. warning::', '\\warning') text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n * '.join(text.strip().split('\n') + suffix)
def format_doc(packet): text = common.select_lang(packet.get_doc()[1]) link = '<see cref="{0}{1}.T{0}{1}.{2}"/>' # escape XML special chars text = escape(text) # handle notes and warnings lines = text.split('\n') replaced_lines = [] in_note = False in_warning = False in_table_head = False in_table_body = False for line in lines: if line.strip() == '.. note::': in_note = True replaced_lines.append('<note>') elif line.strip() == '.. warning::': in_warning = True replaced_lines.append('<note type="caution">') elif len(line.strip()) == 0 and (in_note or in_warning): if in_note: in_note = False if in_warning: in_warning = False replaced_lines.append('</note>') replaced_lines.append('') elif line.strip() == '.. csv-table::': in_table_head = True replaced_lines.append('<code>') elif line.strip().startswith(':header: ') and in_table_head: replaced_lines.append(line[len(':header: '):]) elif line.strip().startswith(':widths:') and in_table_head: pass elif len(line.strip()) == 0 and in_table_head: in_table_head = False in_table_body = True replaced_lines.append('') elif len(line.strip()) == 0 and in_table_body: in_table_body = False replaced_lines.append('</code>') replaced_lines.append('') else: replaced_lines.append(line) text = '\n'.join(replaced_lines) cls = device.get_camel_case_name() for other_packet in device.get_packets(): name_false = ':func:`{0}`'.format(other_packet.get_camel_case_name()) name = other_packet.get_camel_case_name() name_right = link.format(device.get_category(), cls, name) text = text.replace(name_false, name_right) text = text.replace(":word:`parameter`", "parameter") text = text.replace(":word:`parameters`", "parameters") text = common.handle_rst_if(text, device) text = common.handle_since_firmware(text, device, packet) return '\n /// '.join(text.strip().split('\n'))