[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [26073] trunk/blender/source/blender/ python/sphinx_doc_gen.py: reference docs: include type info with function return values
Campbell Barton
ideasman42 at gmail.com
Mon Jan 18 11:45:54 CET 2010
Revision: 26073
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=26073
Author: campbellbarton
Date: 2010-01-18 11:45:54 +0100 (Mon, 18 Jan 2010)
Log Message:
-----------
reference docs: include type info with function return values
Modified Paths:
--------------
trunk/blender/source/blender/python/sphinx_doc_gen.py
Modified: trunk/blender/source/blender/python/sphinx_doc_gen.py
===================================================================
--- trunk/blender/source/blender/python/sphinx_doc_gen.py 2010-01-18 10:02:55 UTC (rev 26072)
+++ trunk/blender/source/blender/python/sphinx_doc_gen.py 2010-01-18 10:45:54 UTC (rev 26073)
@@ -98,14 +98,18 @@
if is_return:
id_name = "return"
id_type = "rtype"
+ kwargs = {"as_ret": True, "class_fmt": ":class:`%s`"}
+ identifier = ""
else:
id_name = "arg"
id_type = "type"
+ kwargs = {"as_arg": True, "class_fmt": ":class:`%s`"}
+ identifier = " %s" % prop.identifier
- type_descr = prop.get_type_description(as_arg=True, class_fmt=":class:`%s`")
+ type_descr = prop.get_type_description(**kwargs)
if prop.name or prop.description:
- fw(ident + ":%s %s: %s\n" % (id_name, prop.identifier, ", ".join([val for val in (prop.name, prop.description) if val])))
- fw(ident + ":%s %s: %s\n" % (id_type, prop.identifier, type_descr))
+ fw(ident + ":%s%s: %s\n" % (id_name, identifier, ", ".join([val for val in (prop.name, prop.description) if val])))
+ fw(ident + ":%s%s: %s\n" % (id_type, identifier, type_descr))
def write_struct(struct):
#if not struct.identifier.startswith("Sc") and not struct.identifier.startswith("I"):
More information about the Bf-blender-cvs
mailing list