mirror of
https://github.com/godotengine/godot
synced 2024-09-05 21:10:10 +00:00
Update doc status generator.
[ciskip]
This commit is contained in:
parent
57516a4473
commit
e23454d5c3
|
@ -1,5 +1,6 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import os
|
||||
import sys
|
||||
import re
|
||||
import math
|
||||
|
@ -220,6 +221,21 @@ class ClassStatus:
|
|||
def generate_for_class(c):
|
||||
status = ClassStatus()
|
||||
status.name = c.attrib['name']
|
||||
|
||||
# setgets do not count
|
||||
methods = []
|
||||
for tag in list(c):
|
||||
if tag.tag in ['methods']:
|
||||
for sub_tag in list(tag):
|
||||
methods.append(sub_tag.find('name'))
|
||||
if tag.tag in ['members']:
|
||||
for sub_tag in list(tag):
|
||||
try:
|
||||
methods.remove(sub_tag.find('setter'))
|
||||
methods.remove(sub_tag.find('getter'))
|
||||
except:
|
||||
pass
|
||||
|
||||
for tag in list(c):
|
||||
|
||||
if tag.tag == 'brief_description':
|
||||
|
@ -230,9 +246,9 @@ class ClassStatus:
|
|||
|
||||
elif tag.tag in ['methods', 'signals']:
|
||||
for sub_tag in list(tag):
|
||||
if sub_tag.find('name') in methods or tag.tag == 'signals':
|
||||
descr = sub_tag.find('description')
|
||||
status.progresses[tag.tag].increment(len(descr.text.strip()) > 0)
|
||||
|
||||
elif tag.tag in ['constants', 'members']:
|
||||
for sub_tag in list(tag):
|
||||
status.progresses[tag.tag].increment(len(sub_tag.text.strip()) > 0)
|
||||
|
@ -252,6 +268,7 @@ class ClassStatus:
|
|||
|
||||
input_file_list = []
|
||||
input_class_list = []
|
||||
merged_file = ""
|
||||
|
||||
for arg in sys.argv[1:]:
|
||||
if arg.startswith('--'):
|
||||
|
@ -259,8 +276,10 @@ for arg in sys.argv[1:]:
|
|||
elif arg.startswith('-'):
|
||||
for f in arg[1:]:
|
||||
flags[f] = not flags[f]
|
||||
elif arg.endswith('.xml'):
|
||||
input_file_list.append(arg)
|
||||
elif os.path.isdir(arg):
|
||||
for f in os.listdir(arg):
|
||||
if f.endswith('.xml'):
|
||||
input_file_list.append(os.path.join(arg, f));
|
||||
else:
|
||||
input_class_list.append(arg)
|
||||
|
||||
|
@ -287,10 +306,9 @@ if flags['u']:
|
|||
|
||||
if len(input_file_list) < 1 or flags['h']:
|
||||
if not flags['h']:
|
||||
print(color('section', 'Invalid usage') + ': At least one classes.xml file is required')
|
||||
print(color('section', 'Usage') + ': doc_status.py [flags] <classes.xml> [class names]')
|
||||
print(color('section', 'Invalid usage') + ': Please specify a classes directory')
|
||||
print(color('section', 'Usage') + ': doc_status.py [flags] <classes_dir> [class names]')
|
||||
print('\t< and > signify required parameters, while [ and ] signify optional parameters.')
|
||||
print('\tNote that you can give more than one classes file, in which case they will be merged on-the-fly.')
|
||||
print(color('section', 'Available flags') + ':')
|
||||
possible_synonym_list = list(long_flags)
|
||||
possible_synonym_list.sort()
|
||||
|
@ -327,11 +345,10 @@ for file in input_file_list:
|
|||
|
||||
version = doc.attrib['version']
|
||||
|
||||
for c in list(doc):
|
||||
if c.attrib['name'] in class_names:
|
||||
if doc.attrib['name'] in class_names:
|
||||
continue
|
||||
class_names.append(c.attrib['name'])
|
||||
classes[c.attrib['name']] = c
|
||||
class_names.append(doc.attrib['name'])
|
||||
classes[doc.attrib['name']] = doc
|
||||
|
||||
class_names.sort()
|
||||
|
||||
|
|
Loading…
Reference in a new issue