diff options
author | Campbell Barton <ideasman42@gmail.com> | 2009-04-07 15:45:48 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2009-04-07 15:45:48 +0400 |
commit | 1534eca60f181dc4e4299f6bdf73a66bbdf87970 (patch) | |
tree | 06d8101044f784a92ce26d136a58f6573b9e9517 /source/gameengine/PyDoc | |
parent | 5d64dd019e7e8150db40505097d1b4048f4e0153 (diff) |
Updated bge_api_validate_py.txt to check for undocumented attributes
All types methods and attributes are now documented (except for some types have no epydoc .py files for at all)
Diffstat (limited to 'source/gameengine/PyDoc')
-rw-r--r-- | source/gameengine/PyDoc/KX_MeshProxy.py | 3 | ||||
-rw-r--r-- | source/gameengine/PyDoc/KX_VertexProxy.py | 5 | ||||
-rw-r--r-- | source/gameengine/PyDoc/SCA_RandomSensor.py | 7 | ||||
-rw-r--r-- | source/gameengine/PyDoc/bge_api_validate_py.txt | 50 |
4 files changed, 61 insertions, 4 deletions
diff --git a/source/gameengine/PyDoc/KX_MeshProxy.py b/source/gameengine/PyDoc/KX_MeshProxy.py index 03bc36b6ac1..c6855d3b0a5 100644 --- a/source/gameengine/PyDoc/KX_MeshProxy.py +++ b/source/gameengine/PyDoc/KX_MeshProxy.py @@ -45,7 +45,8 @@ class KX_MeshProxy: m_i += 1 mesh = obj.getMesh(m_i) - + @ivar materials: + @type materials: list of L{KX_BlenderMaterial} or L{KX_PolygonMaterial} types """ def getNumMaterials(): diff --git a/source/gameengine/PyDoc/KX_VertexProxy.py b/source/gameengine/PyDoc/KX_VertexProxy.py index 5baaf76c3d9..7ee5087b316 100644 --- a/source/gameengine/PyDoc/KX_VertexProxy.py +++ b/source/gameengine/PyDoc/KX_VertexProxy.py @@ -34,6 +34,11 @@ class KX_VertexProxy: @ivar v: The v texture coordinate of the vertex. @type v: float + @ivar u2: The second u texture coordinate of the vertex. + @type u2: float + @ivar v2: The second v texture coordinate of the vertex. + @type v2: float + @group Colour: r, g, b, a @ivar r: The red component of the vertex colour. 0.0 <= r <= 1.0 @type r: float diff --git a/source/gameengine/PyDoc/SCA_RandomSensor.py b/source/gameengine/PyDoc/SCA_RandomSensor.py index 940b8f879ff..6dc0a3c23c0 100644 --- a/source/gameengine/PyDoc/SCA_RandomSensor.py +++ b/source/gameengine/PyDoc/SCA_RandomSensor.py @@ -5,6 +5,11 @@ from SCA_ISensor import * class SCA_RandomSensor(SCA_ISensor): """ This sensor activates randomly. + + @ivar lastDraw: The seed of the random number generator. + @type lastDraw: int + @ivar seed: The seed of the random number generator. + @type seed: int """ def setSeed(seed): @@ -25,4 +30,6 @@ class SCA_RandomSensor(SCA_ISensor): def getLastDraw(): """ Returns the last random number generated. + + @rtype: integer """ diff --git a/source/gameengine/PyDoc/bge_api_validate_py.txt b/source/gameengine/PyDoc/bge_api_validate_py.txt index e003f29831b..58dfbadba15 100644 --- a/source/gameengine/PyDoc/bge_api_validate_py.txt +++ b/source/gameengine/PyDoc/bge_api_validate_py.txt @@ -15,6 +15,7 @@ BGE_API_DOC_PATH = 'source/gameengine/PyDoc' +import GameTypes type_members = {} for type_name in dir(GameTypes): @@ -40,12 +41,49 @@ doc_dir= os.path.join(os.getcwd(), BGE_API_DOC_PATH) if doc_dir not in sys.path: sys.path.append(doc_dir) + +def check_attribute(type_mame, member): + filename = os.path.join(doc_dir, type_mame + '.py') + # print filename + + file = open(filename, 'rU') + + for l in file: + l = l.strip() + + ''' + @ivar foo: blah blah + to + foo + + ''' + + if l.startswith('@ivar'): + var = l.split()[1].split(':')[0] + + if var == member: + file.close() + return True + + file.close() + return False + + + + + + +print '\n\n\nChecking Docs' + +PRINT_OK = False + for type_name in sorted(type_members.keys()): members = type_members[type_name] try: mod = __import__(type_name) - print "type: %s" % type_name + if PRINT_OK: + print "type: %s" % type_name except: print "missing: %s - %s" % (type_name, str(members)) continue @@ -61,6 +99,12 @@ for type_name in sorted(type_members.keys()): for member in sorted(members): try: getattr(type_class, member) - print "\tfound: %s.%s" % (type_name, member) + if PRINT_OK: + print "\tfound: %s.%s" % (type_name, member) except: - print "\tmissing: %s.%s" % (type_name, member) + if check_attribute(type_name, member): + if PRINT_OK: + print "\tfound attr: %s.%s" % (type_name, member) + else: + print "\tmissing: %s.%s" % (type_name, member) + |