pengjunjie/build_tools
1
0
Fork 1
mirror of https://github.com/ONLYOFFICE/build_tools.git synced 2026-02-10 20:45:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request '[jsdoc] FIx paths in enums' (#39) from fix/js-doc into release/v8.3.0

Browse Source 
Reviewed-on: https://git.onlyoffice.com/ONLYOFFICE/build_tools/pulls/39
This commit is contained in:
Oleg Korshul
2025-01-27 06:37:46 +00:00
parent a3cb31291f 8ee874da14
commit 27de97031e
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
scripts/sdkjs_common/jsdoc/generate_docs_md.py
View File

@ -168,7 +168,7 @@ def generate_data_types_markdown(types, enumerations, classes, root='../../'):
def generate_class_markdown(class_name, methods, properties, enumerations, classes):
content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
content += generate_properties_markdown(properties, enumerations, classes, '../')
content += generate_properties_markdown(properties, enumerations, classes)
content += "## Methods\n\n"
for method in methods:
@ -235,7 +235,7 @@ def generate_method_markdown(method, enumerations, classes):
return escape_text_outside_code_blocks(content)
def generate_properties_markdown(properties, enumerations, classes, root='../../'):
def generate_properties_markdown(properties, enumerations, classes, root='../'):
if properties is None:
return ''

8
scripts/sdkjs_common/jsdoc/generate_docs_plugins_md.py
View File

@ -168,7 +168,7 @@ def generate_data_types_markdown(types, enumerations, classes, root='../../'):
def generate_class_markdown(class_name, methods, properties, enumerations, classes):
content = f"# {class_name}\n\nRepresents the {class_name} class.\n\n"
content += generate_properties_markdown(properties, enumerations, classes, '../')
content += generate_properties_markdown(properties, enumerations, classes)
content += "## Methods\n\n"
for method in methods:
@ -256,7 +256,7 @@ def generate_method_markdown(method, enumerations, classes):
return escape_text_outside_code_blocks(content)
def generate_properties_markdown(properties, enumerations, classes, root='../../'):
def generate_properties_markdown(properties, enumerations, classes, root='../'):
if properties is None:
return ''
@ -309,9 +309,9 @@ def generate_enumeration_markdown(enumeration, enumerations, classes):
for raw_t in enumeration['type']['names']:
# Attempt linking
if any(enum['name'] == raw_t for enum in enumerations):
content += f"- [{raw_t}](../../Enumeration/{raw_t}.md)\n"
content += f"- [{raw_t}](../Enumeration/{raw_t}.md)\n"
elif raw_t in classes:
content += f"- [{raw_t}](../../{raw_t}/{raw_t}.md)\n"
content += f"- [{raw_t}](../{raw_t}/{raw_t}.md)\n"
else:
content += f"- {raw_t}\n"