TheCloud/panda3d
1
0
Fork 0
mirror of https://github.com/panda3d/panda3d.git synced 2025-10-18 12:43:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

Added C++ constructors to API reference

Browse Source
This commit is contained in:
rdb 2008-09-23 14:18:44 +00:00
parent 20225878a6
commit 2daea47ccf
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
direct/src/directscripts/gendocs.py
View File

@ -634,6 +634,18 @@ class CodeDatabase:
else: else:
return pathToModule(type.file) return pathToModule(type.file)
def getClassConstructors(self, cn):
# Only detects C++ constructors, not Python constructors, since
# those are treated as ordinary methods.
type = self.types.get(cn)
result = []
if (isinstance(type, InterrogateType)):
for constructor in type.constructors:
func = type.db.functions[constructor]
if (func.classindex == type.index):
result.append(type.scopedname+"."+func.pyname)
return result
def getClassMethods(self, cn): def getClassMethods(self, cn):
type = self.types.get(cn) type = self.types.get(cn)
result = [] result = []
@ -811,8 +823,12 @@ def generate(pversion, indirlist, directdirlist, docdir, header, footer, urlpref
for sclass in inheritance: for sclass in inheritance:
methods = code.getClassMethods(sclass)[:] methods = code.getClassMethods(sclass)[:]
methods.sort(None, str.lower) methods.sort(None, str.lower)
if (len(methods) > 0): constructors = code.getClassConstructors(sclass)
if (len(methods) > 0 or len(constructors) > 0):
body = body + "<h2>Methods of "+sclass+":</h2>\n<ul>\n" body = body + "<h2>Methods of "+sclass+":</h2>\n<ul>\n"
if len(constructors) > 0:
fn = code.getFunctionName(constructors[0])
body = body + '<a href="#' + fn + '">' + fn + " (Constructor)</a><br>\n"
for method in methods: for method in methods:
fn = code.getFunctionName(method) fn = code.getFunctionName(method)
body = body + '<a href="#' + fn + '">' + fn + "</a><br>\n" body = body + '<a href="#' + fn + '">' + fn + "</a><br>\n"
@ -825,6 +841,9 @@ def generate(pversion, indirlist, directdirlist, docdir, header, footer, urlpref
body = body + "<tr><td>" + value + "</td><td>" + comment + "</td></tr>\n" body = body + "<tr><td>" + value + "</td><td>" + comment + "</td></tr>\n"
body = body + "</table></ul>" body = body + "</table></ul>"
for sclass in inheritance: for sclass in inheritance:
constructors = code.getClassConstructors(sclass)
for constructor in constructors:
body = body + generateFunctionDocs(code, constructor)
methods = code.getClassMethods(sclass)[:] methods = code.getClassMethods(sclass)[:]
methods.sort(None, str.lower) methods.sort(None, str.lower)
for method in methods: for method in methods: