diff options
author | Campbell Barton <ideasman42@gmail.com> | 2010-02-28 14:54:48 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2010-02-28 14:54:48 +0300 |
commit | fc1cb1670e1f263d75ec07965028529e6dc52bc3 (patch) | |
tree | e295a46f852e4ade956ca5c568511fb5f167bf02 /source/blender/python | |
parent | 3bbf1917c51bc005d8c5f5d64c5f7546b3e459c2 (diff) |
include BLF in automated doc generation
http://www.blender.org/documentation/250PythonDoc/BLF.html
Diffstat (limited to 'source/blender/python')
-rw-r--r-- | source/blender/python/doc/sphinx_doc_gen.py | 5 | ||||
-rw-r--r-- | source/blender/python/generic/BLF.c | 8 |
2 files changed, 8 insertions, 5 deletions
diff --git a/source/blender/python/doc/sphinx_doc_gen.py b/source/blender/python/doc/sphinx_doc_gen.py index e3258a15655..bfe51eddf32 100644 --- a/source/blender/python/doc/sphinx_doc_gen.py +++ b/source/blender/python/doc/sphinx_doc_gen.py @@ -270,6 +270,7 @@ def rna2sphinx(BASEPATH): fw(" bpy.props.rst\n\n") fw(" Mathutils.rst\n\n") + fw(" BLF.rst\n\n") file.close() @@ -313,7 +314,9 @@ def rna2sphinx(BASEPATH): 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") diff --git a/source/blender/python/generic/BLF.c b/source/blender/python/generic/BLF.c index 71f531bf5d7..df1497f6573 100644 --- a/source/blender/python/generic/BLF.c +++ b/source/blender/python/generic/BLF.c @@ -48,7 +48,7 @@ static PyObject *py_blf_position(PyObject *self, PyObject *args) 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 PyObject *py_blf_aspect(PyObject *self, PyObject *args) 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) { |