[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [27186] trunk/blender/source/blender/ python: include BLF in automated doc generation

[Campbell Barton]

Revision: 27186
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=27186
Author:   campbellbarton
Date:     2010-02-28 12:54:48 +0100 (Sun, 28 Feb 2010)

Log Message:
-----------
include BLF in automated doc generation
 http://www.blender.org/documentation/250PythonDoc/BLF.html

Modified Paths:
--------------
    trunk/blender/source/blender/python/doc/sphinx_doc_gen.py
    trunk/blender/source/blender/python/generic/BLF.c

Modified: trunk/blender/source/blender/python/doc/sphinx_doc_gen.py
===================================================================
--- trunk/blender/source/blender/python/doc/sphinx_doc_gen.py	2010-02-28 11:18:54 UTC (rev 27185)
+++ trunk/blender/source/blender/python/doc/sphinx_doc_gen.py	2010-02-28 11:54:48 UTC (rev 27186)
@@ -270,6 +270,7 @@
     fw("   bpy.props.rst\n\n")
     
     fw("   Mathutils.rst\n\n")
+    fw("   BLF.rst\n\n")
 
     file.close()
 
@@ -313,8 +314,10 @@
     pymodule2sphinx(BASEPATH, "Mathutils", module, "Math Types & Utilities (Mathutils)")
     del module
 
+    import BLF as module
+    pymodule2sphinx(BASEPATH, "BLF", module, "Blender Font Drawing (BLF)")
+    del module
 
-
     if 0:
         filepath = os.path.join(BASEPATH, "bpy.rst")
         file = open(filepath, "w")

Modified: trunk/blender/source/blender/python/generic/BLF.c
===================================================================
--- trunk/blender/source/blender/python/generic/BLF.c	2010-02-28 11:18:54 UTC (rev 27185)
+++ trunk/blender/source/blender/python/generic/BLF.c	2010-02-28 11:54:48 UTC (rev 27186)
@@ -48,7 +48,7 @@
 static char py_blf_size_doc[] =
 ".. function:: size(size, dpi)\n"
 "\n"
-"   Set the position for drawing text.\n"
+"   Set the size and dpi for drawing text.\n"
 "\n"
 "   :arg size: Point size of the font.\n"
 "   :type size: int\n"
@@ -90,12 +90,12 @@
 
 
 static char py_blf_blur_doc[] =
-".. function:: blur(aspect)\n"
+".. function:: blur(radius)\n"
 "\n"
 "   Set the blur radius for drawing text.\n"
 "\n"
-"   :arg blur: The radius for bluring text.\n"
-"   :type aspect: float\n";
+"   :arg radius: The radius for blurring text (in pixels).\n"
+"   :type radius: int\n";
 
 static PyObject *py_blf_blur(PyObject *self, PyObject *args)
 {