[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [33505] trunk/blender: include getset' s for generating module docs.

Campbell Barton ideasman42 at gmail.com
Mon Dec 6 13:36:55 CET 2010


Revision: 33505
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=33505
Author:   campbellbarton
Date:     2010-12-06 13:36:55 +0100 (Mon, 06 Dec 2010)

Log Message:
-----------
include getset's for generating module docs.
used for bpy.debug/tempdir/driver_namespace which were previously undocumented.

Modified Paths:
--------------
    trunk/blender/doc/python_api/sphinx_doc_gen.py
    trunk/blender/source/blender/python/intern/bpy_app.c

Modified: trunk/blender/doc/python_api/sphinx_doc_gen.py
===================================================================
--- trunk/blender/doc/python_api/sphinx_doc_gen.py	2010-12-06 10:56:37 UTC (rev 33504)
+++ trunk/blender/doc/python_api/sphinx_doc_gen.py	2010-12-06 12:36:55 UTC (rev 33505)
@@ -224,6 +224,16 @@
     # write members of the module
     # only tested with PyStructs which are not exactly modules
     for key, descr in sorted(type(module).__dict__.items()):
+        if key.startswith("__"):
+            continue
+        # naughty, we also add getset's into PyStructs, this is not typical py but also not incorrect.
+        if type(descr) == types.GetSetDescriptorType: # 'bpy_app_type' name is only used for examples and messages
+            py_descr2sphinx("", fw, descr, module_name, "bpy_app_type", key)
+            attribute_set.add(key)
+    for key, descr in sorted(type(module).__dict__.items()):
+        if key.startswith("__"):
+            continue
+
         if type(descr) == types.MemberDescriptorType:
             if descr.__doc__:
                 fw(".. data:: %s\n\n" % key)

Modified: trunk/blender/source/blender/python/intern/bpy_app.c
===================================================================
--- trunk/blender/source/blender/python/intern/bpy_app.c	2010-12-06 10:56:37 UTC (rev 33504)
+++ trunk/blender/source/blender/python/intern/bpy_app.c	2010-12-06 12:36:55 UTC (rev 33505)
@@ -59,10 +59,10 @@
 	{(char *)"build_revision", (char *)"The subversion revision this blender instance was built with"},
 	{(char *)"build_platform", (char *)"The platform this blender instance was built for"},
 	{(char *)"build_type", (char *)"The type of build (Release, Debug)"},
-	{(char *)"build_cflags", (char *)""},
-	{(char *)"build_cxxflags", (char *)""},
-	{(char *)"build_linkflags", (char *)""},
-	{(char *)"build_system", (char *)""},
+	{(char *)"build_cflags", (char *)"C compiler flags"},
+	{(char *)"build_cxxflags", (char *)"C++ compiler flags"},
+	{(char *)"build_linkflags", (char *)"Binary linking flags"},
+	{(char *)"build_system", (char *)"Build system used"},
 	{0}
 };
 





More information about the Bf-blender-cvs mailing list