osmith
/
wireshark
forked from osmocom/wireshark
1
0
Fork 0
Code Pull Requests Releases Wiki Activity

docbook: Add file comments to wsluarm. 

Add a comment to each class and function noting which C file it is
defined in.
This commit is contained in:
Gerald Combs 2022-07-23 16:15:42 -07:00
parent c252852c9d
commit e68db21421
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docbook/make-wsluarm.py
View File

@ -196,8 +196,8 @@ class LuaFunction:
section_name = re.sub('[^A-Za-z0-9]', '_', f'{self.name}_{"__".join(mangled_names)}_') section_name = re.sub('[^A-Za-z0-9]', '_', f'{self.name}_{"__".join(mangled_names)}_')
opt_names = [f'[{a}]' if optional else a for a, _, optional in self.arguments] opt_names = [f'[{a}]' if optional else a for a, _, optional in self.arguments]
adoc_buf = f''' adoc_buf = f'''
// {self.c_file}
[#lua_fn_{section_name}] [#lua_fn_{section_name}]
===== {self.name}({', '.join(opt_names)}) ===== {self.name}({', '.join(opt_names)})
{self.description} {self.description}
@ -403,15 +403,15 @@ def main():
with open(os.path.join(args.output_directory, adoc_file), 'w', encoding='utf-8') as adoc_f: with open(os.path.join(args.output_directory, adoc_file), 'w', encoding='utf-8') as adoc_f:
adoc_f.write(f'''\ adoc_f.write(f'''\
// {c_file}
[#lua_module_{module_name}] [#lua_module_{module_name}]
=== {modules[module_name]["description"]} === {modules[module_name]["description"]}
''') ''')
for class_name in sorted(classes.keys()): for class_name in sorted(classes.keys()):
lua_class = classes[class_name] lua_class = classes[class_name]
adoc_f.write(f''' adoc_f.write(f'''
// {c_file}
[#lua_class_{class_name}] [#lua_class_{class_name}]
==== {class_name} ==== {class_name}
''') ''')
@ -430,7 +430,6 @@ def main():
attribute_id = re.sub('[^A-Za-z0-9]', '_', f'{attribute["name"]}') attribute_id = re.sub('[^A-Za-z0-9]', '_', f'{attribute["name"]}')
adoc_f.write(f''' adoc_f.write(f'''
[#lua_class_attrib_{attribute_id}] [#lua_class_attrib_{attribute_id}]
===== {attribute["name"]} ===== {attribute["name"]}
{attribute["description"]} {attribute["description"]}
@ -444,7 +443,6 @@ def main():
if len(functions.keys()) > 0: if len(functions.keys()) > 0:
adoc_f.write(f'''\ adoc_f.write(f'''\
[#global_functions_{module_name}] [#global_functions_{module_name}]
==== Global Functions ==== Global Functions
''') ''')