Sweetbread/kolibrios
1
0
Fork 0
forked from KolibriOS/kolibrios
Code Pull Requests Activity

[kernel][asmxygen.py] Implement very basic macro and struct documentation generation

Browse Source 
git-svn-id: svn://kolibrios.org@8846 a494cfbc-eb01-0410-851d-a64ba20cac60
This commit is contained in:
Magomed Kostoev (mkostoevr) 2021-06-13 22:23:55 +00:00
parent 9bb8aaa1cf
commit ff0745456b
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
kernel/trunk/asmxygen.py
View File

@ -240,6 +240,26 @@ def write_label(source, line, name, brief = "Undocumented"):
f"void {name}();\n\n") f"void {name}();\n\n")
write_something(source, something) write_something(source, something)
def write_macro(source, line, name, brief = "Undocumented"):
name = name.replace(".", "_")
something = (f"/**\n" +
f" * @def {name}\n" +
f" * @brief {brief}\n" +
f" * @par Source\n" +
f" * <a href='{link_root}/{source}#line-{line}'>{source}:{line}</a>\n" +
f" */\n#define {name}\n\n")
write_something(source, something)
def write_structure(source, line, name, brief = "Undocumented"):
name = name.replace(".", "_")
something = (f"/**\n" +
f" * @struct {name}\n" +
f" * @brief {brief}\n" +
f" * @par Source\n" +
f" * <a href='{link_root}/{source}#line-{line}'>{source}:{line}</a>\n" +
f" */\nstruct {name}" + " {};\n\n")
write_something(source, something)
i = 1 i = 1
for source in kernel_structure: for source in kernel_structure:
# Print progress: current/total # Print progress: current/total
@ -254,4 +274,10 @@ for source in kernel_structure:
if len(kernel_structure[source][LABELS]) > 0: if len(kernel_structure[source][LABELS]) > 0:
for label in kernel_structure[source][LABELS]: for label in kernel_structure[source][LABELS]:
write_label(source, label[0], label[1]) write_label(source, label[0], label[1])
if len(kernel_structure[source][MACROS]) > 0:
for macro in kernel_structure[source][MACROS]:
write_macro(source, macro[0], macro[1])
if len(kernel_structure[source][STRUCTURES]) > 0:
for structure in kernel_structure[source][STRUCTURES]:
write_structure(source, structure[0], structure[1])
i += 1 i += 1