[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [36871] trunk/blender: use PyDoc_STRVAR macro, so its possible to build without docstrings.

Campbell Barton ideasman42 at gmail.com
Tue May 24 18:05:54 CEST 2011


Revision: 36871
          http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=36871
Author:   campbellbarton
Date:     2011-05-24 16:05:51 +0000 (Tue, 24 May 2011)
Log Message:
-----------
use PyDoc_STRVAR macro, so its possible to build without docstrings.

Modified Paths:
--------------
    trunk/blender/doc/python_api/examples/bpy.types.BlendDataLibraries.load.py
    trunk/blender/source/blender/python/generic/bgl.c
    trunk/blender/source/blender/python/generic/blf_py_api.c
    trunk/blender/source/blender/python/generic/mathutils.c
    trunk/blender/source/blender/python/generic/mathutils_Color.c
    trunk/blender/source/blender/python/generic/mathutils_Euler.c
    trunk/blender/source/blender/python/generic/mathutils_Matrix.c
    trunk/blender/source/blender/python/generic/mathutils_Quaternion.c
    trunk/blender/source/blender/python/generic/mathutils_Vector.c
    trunk/blender/source/blender/python/generic/mathutils_geometry.c
    trunk/blender/source/blender/python/generic/noise_py_api.c
    trunk/blender/source/blender/python/intern/bpy.c
    trunk/blender/source/blender/python/intern/bpy_library.c
    trunk/blender/source/blender/python/intern/bpy_props.c
    trunk/blender/source/blender/python/intern/bpy_rna.c

Modified: trunk/blender/doc/python_api/examples/bpy.types.BlendDataLibraries.load.py
===================================================================
--- trunk/blender/doc/python_api/examples/bpy.types.BlendDataLibraries.load.py	2011-05-24 15:44:13 UTC (rev 36870)
+++ trunk/blender/doc/python_api/examples/bpy.types.BlendDataLibraries.load.py	2011-05-24 16:05:51 UTC (rev 36871)
@@ -34,6 +34,6 @@
 with bpy.data.libraries.load(filepath) as (data_from, data_to):
     data_to.meshes = data_from.meshes
 # now operate directly on the loaded data
-for mesh in mdata_to.meshes:
+for mesh in data_to.meshes:
     if mesh is not None:
         print(mesh.name)

Modified: trunk/blender/source/blender/python/generic/bgl.c
===================================================================
--- trunk/blender/source/blender/python/generic/bgl.c	2011-05-24 15:44:13 UTC (rev 36870)
+++ trunk/blender/source/blender/python/generic/bgl.c	2011-05-24 16:05:51 UTC (rev 36871)
@@ -45,7 +45,7 @@
 #include "BLI_utildefines.h"
 
 
-static char Method_Buffer_doc[] =
+PyDoc_STRVAR(Method_Buffer_doc,
 	"(type, dimensions, [template]) - Create a new Buffer object\n\n\
 (type) - The format to store data in\n\
 (dimensions) - An int or sequence specifying the dimensions of the buffer\n\
@@ -59,7 +59,8 @@
 is determined by the value in the sequence at that index.\n\n\
 For example, passing [100, 100] will create a 2 dimensional\n\
 square buffer. Passing [16, 16, 32] will create a 3 dimensional\n\
-buffer which is twice as deep as it is wide or high.";
+buffer which is twice as deep as it is wide or high."
+);
 
 static PyObject *Method_Buffer( PyObject * self, PyObject *args );
 

Modified: trunk/blender/source/blender/python/generic/blf_py_api.c
===================================================================
--- trunk/blender/source/blender/python/generic/blf_py_api.c	2011-05-24 15:44:13 UTC (rev 36870)
+++ trunk/blender/source/blender/python/generic/blf_py_api.c	2011-05-24 16:05:51 UTC (rev 36871)
@@ -36,7 +36,7 @@
 
 
 
-static char py_blf_position_doc[] =
+PyDoc_STRVAR(py_blf_position_doc,
 ".. function:: position(fontid, x, y, z)\n"
 "\n"
 "   Set the position for drawing text.\n"
@@ -48,7 +48,8 @@
 "   :arg y: Y axis position to draw the text.\n"
 "   :type y: float\n"
 "   :arg z: Z axis position to draw the text.\n"
-"   :type z: float\n";
+"   :type z: float\n"
+);
 
 static PyObject *py_blf_position(PyObject *UNUSED(self), PyObject *args)
 {
@@ -64,7 +65,7 @@
 }
 
 
-static char py_blf_size_doc[] =
+PyDoc_STRVAR(py_blf_size_doc,
 ".. function:: size(fontid, size, dpi)\n"
 "\n"
 "   Set the size and dpi for drawing text.\n"
@@ -74,8 +75,8 @@
 "   :arg size: Point size of the font.\n"
 "   :type size: int\n"
 "   :arg dpi: dots per inch value to use for drawing.\n"
-"   :type dpi: int\n";
-
+"   :type dpi: int\n"
+);
 static PyObject *py_blf_size(PyObject *UNUSED(self), PyObject *args)
 {
 	int fontid, size, dpi;
@@ -89,7 +90,7 @@
 }
 
 
-static char py_blf_aspect_doc[] =
+PyDoc_STRVAR(py_blf_aspect_doc,
 ".. function:: aspect(fontid, aspect)\n"
 "\n"
 "   Set the aspect for drawing text.\n"
@@ -97,8 +98,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg aspect: The aspect ratio for text drawing to use.\n"
-"   :type aspect: float\n";
-
+"   :type aspect: float\n"
+);
 static PyObject *py_blf_aspect(PyObject *UNUSED(self), PyObject *args)
 {
 	float aspect;
@@ -113,7 +114,7 @@
 }
 
 
-static char py_blf_blur_doc[] =
+PyDoc_STRVAR(py_blf_blur_doc,
 ".. function:: blur(fontid, radius)\n"
 "\n"
 "   Set the blur radius for drawing text.\n"
@@ -121,8 +122,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg radius: The radius for blurring text (in pixels).\n"
-"   :type radius: int\n";
-
+"   :type radius: int\n"
+);
 static PyObject *py_blf_blur(PyObject *UNUSED(self), PyObject *args)
 {
 	int blur, fontid;
@@ -136,7 +137,7 @@
 }
 
 
-static char py_blf_draw_doc[] =
+PyDoc_STRVAR(py_blf_draw_doc,
 ".. function:: draw(fontid, text)\n"
 "\n"
 "   Draw text in the current context.\n"
@@ -144,8 +145,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg text: the text to draw.\n"
-"   :type text: string\n";
-
+"   :type text: string\n"
+);
 static PyObject *py_blf_draw(PyObject *UNUSED(self), PyObject *args)
 {
 	char *text;
@@ -160,7 +161,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_dimensions_doc[] =
+PyDoc_STRVAR(py_blf_dimensions_doc,
 ".. function:: dimensions(fontid, text)\n"
 "\n"
 "   Return the width and height of the text.\n"
@@ -170,8 +171,8 @@
 "   :arg text: the text to draw.\n"
 "   :type text: string\n"
 "   :return: the width and height of the text.\n"
-"   :rtype: tuple of 2 floats\n";
-
+"   :rtype: tuple of 2 floats\n"
+);
 static PyObject *py_blf_dimensions(PyObject *UNUSED(self), PyObject *args)
 {
 	char *text;
@@ -190,7 +191,7 @@
 	return ret;
 }
 
-static char py_blf_clipping_doc[] =
+PyDoc_STRVAR(py_blf_clipping_doc,
 ".. function:: clipping(fontid, xmin, ymin, xmax, ymax)\n"
 "\n"
 "   Set the clipping, enable/disable using CLIPPING.\n"
@@ -204,8 +205,8 @@
 "   :arg xmax: Clip the drawing area by these bounds.\n"
 "   :type xmax: float\n"
 "   :arg ymax: Clip the drawing area by these bounds.\n"
-"   :type ymax: float\n";
-
+"   :type ymax: float\n"
+);
 static PyObject *py_blf_clipping(PyObject *UNUSED(self), PyObject *args)
 {
 	float xmin, ymin, xmax, ymax;
@@ -219,7 +220,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_disable_doc[] =
+PyDoc_STRVAR(py_blf_disable_doc,
 ".. function:: disable(fontid, option)\n"
 "\n"
 "   Disable option.\n"
@@ -227,8 +228,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
-"   :type option: int\n";
-
+"   :type option: int\n"
+);
 static PyObject *py_blf_disable(PyObject *UNUSED(self), PyObject *args)
 {
 	int option, fontid;
@@ -241,7 +242,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_enable_doc[] =
+PyDoc_STRVAR(py_blf_enable_doc,
 ".. function:: enable(fontid, option)\n"
 "\n"
 "   Enable option.\n"
@@ -249,8 +250,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg option: One of ROTATION, CLIPPING, SHADOW or KERNING_DEFAULT.\n"
-"   :type option: int\n";
-
+"   :type option: int\n"
+);
 static PyObject *py_blf_enable(PyObject *UNUSED(self), PyObject *args)
 {
 	int option, fontid;
@@ -263,7 +264,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_rotation_doc[] =
+PyDoc_STRVAR(py_blf_rotation_doc,
 ".. function:: rotation(fontid, angle)\n"
 "\n"
 "   Set the text rotation angle, enable/disable using ROTATION.\n"
@@ -271,8 +272,8 @@
 "   :arg fontid: The id of the typeface as returned by :func:`blf.load`, for default font use 0.\n"
 "   :type fontid: int\n"
 "   :arg angle: The angle for text drawing to use.\n"
-"   :type angle: float\n";
-
+"   :type angle: float\n"
+);
 static PyObject *py_blf_rotation(PyObject *UNUSED(self), PyObject *args)
 {
 	float angle;
@@ -286,7 +287,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_shadow_doc[] =
+PyDoc_STRVAR(py_blf_shadow_doc,
 ".. function:: shadow(fontid, level, r, g, b, a)\n"
 "\n"
 "   Shadow options, enable/disable using SHADOW .\n"
@@ -302,8 +303,8 @@
 "   :arg b: Shadow color (blue channel 0.0 - 1.0).\n"
 "   :type b: float\n"
 "   :arg a: Shadow color (alpha channel 0.0 - 1.0).\n"
-"   :type a: float\n";
-
+"   :type a: float\n"
+);
 static PyObject *py_blf_shadow(PyObject *UNUSED(self), PyObject *args)
 {
 	int level, fontid;
@@ -322,7 +323,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_shadow_offset_doc[] =
+PyDoc_STRVAR(py_blf_shadow_offset_doc,
 ".. function:: shadow_offset(fontid, x, y)\n"
 "\n"
 "   Set the offset for shadow text.\n"
@@ -332,8 +333,8 @@
 "   :arg x: Vertical shadow offset value in pixels.\n"
 "   :type x: float\n"
 "   :arg y: Horizontal shadow offset value in pixels.\n"
-"   :type y: float\n";
-
+"   :type y: float\n"
+);
 static PyObject *py_blf_shadow_offset(PyObject *UNUSED(self), PyObject *args)
 {
 	int x, y, fontid;
@@ -346,7 +347,7 @@
 	Py_RETURN_NONE;
 }
 
-static char py_blf_load_doc[] =
+PyDoc_STRVAR(py_blf_load_doc,
 ".. function:: load(filename)\n"
 "\n"
 "   Load a new font.\n"
@@ -354,8 +355,8 @@
 "   :arg filename: the filename of the font.\n"
 "   :type filename: string\n"
 "   :return: the new font's fontid or -1 if there was an error.\n"
-"   :rtype: integer\n";
-
+"   :rtype: integer\n"
+);
 static PyObject *py_blf_load(PyObject *UNUSED(self), PyObject *args)
 {
 	char* filename;
@@ -384,9 +385,9 @@
 	{NULL, NULL, 0, NULL}
 };
 
-static char BLF_doc[] =
-"This module provides access to blenders text drawing functions.\n";
-
+PyDoc_STRVAR(BLF_doc,
+"This module provides access to blenders text drawing functions."
+);
 static struct PyModuleDef BLF_module_def = {
 	PyModuleDef_HEAD_INIT,
 	"blf",  /* m_name */

Modified: trunk/blender/source/blender/python/generic/mathutils.c
===================================================================
--- trunk/blender/source/blender/python/generic/mathutils.c	2011-05-24 15:44:13 UTC (rev 36870)
+++ trunk/blender/source/blender/python/generic/mathutils.c	2011-05-24 16:05:51 UTC (rev 36871)
@@ -38,9 +38,9 @@
 #include "BLI_math.h"
 #include "BLI_utildefines.h"
 
-static char M_Mathutils_doc[] =
+PyDoc_STRVAR(M_Mathutils_doc,
 "This module provides access to matrices, eulers, quaternions and vectors."
-;
+);
 static int mathutils_array_parse_fast(float *array, int array_min, int array_max, PyObject *value, const char *error_prefix)
 {
 	PyObject *value_fast= NULL;

Modified: trunk/blender/source/blender/python/generic/mathutils_Color.c
===================================================================
--- trunk/blender/source/blender/python/generic/mathutils_Color.c	2011-05-24 15:44:13 UTC (rev 36870)
+++ trunk/blender/source/blender/python/generic/mathutils_Color.c	2011-05-24 16:05:51 UTC (rev 36871)
@@ -85,7 +85,7 @@
 	return ret;
 }
 
-static char Color_copy_doc[] =
+PyDoc_STRVAR(Color_copy_doc,
 ".. function:: copy()\n"
 "\n"
 "   Returns a copy of this color.\n"
@@ -94,7 +94,7 @@
 "   :rtype: :class:`Color`\n"
 "\n"

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list