From d7e08f2d33207fdf76b1b597ef0de9dec26e3987 Mon Sep 17 00:00:00 2001 From: Tamito Kajiyama Date: Sat, 17 Apr 2010 23:47:47 +0000 Subject: Major documentation updates. The original Freestyle API reference (http://freestyle.sourceforge.net/doc/html/index.html) has been incorporated into the Blender/Freestyle Python API implementation in the form of Sphinx-based embedded docstrings. Some C++-specific descriptions of classes and functions were revised so that they are suitable for Python programmers. Missing docstrings were filled, and sparse descriptions were extended. By means of the new documentation system for Blender, an up-to-date Freestyle Python API reference will be part of the Blender 2.5 documentation. --- .../python/UnaryPredicate0D/BPy_FalseUP0D.cpp | 32 ++++++++++++--------- .../python/UnaryPredicate0D/BPy_TrueUP0D.cpp | 33 +++++++++++++--------- 2 files changed, 39 insertions(+), 26 deletions(-) (limited to 'source/blender/freestyle/intern/python/UnaryPredicate0D') diff --git a/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_FalseUP0D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_FalseUP0D.cpp index a39ac9d02b3..c2c956e3eab 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_FalseUP0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_FalseUP0D.cpp @@ -6,9 +6,25 @@ extern "C" { /////////////////////////////////////////////////////////////////////////////////////////// -/*--------------- Python API function prototypes for FalseUP0D instance -----------*/ +//------------------------INSTANCE METHODS ---------------------------------- -static int FalseUP0D___init__(BPy_FalseUP0D* self, PyObject *args); +static char FalseUP0D___doc__[] = +".. method:: __call__(it)\n" +"\n" +" Always returns false.\n" +"\n" +" :arg it: An Interface0DIterator object.\n" +" :type it: :class:`Interface0DIterator`\n" +" :return: False.\n" +" :rtype: bool\n"; + +static int FalseUP0D___init__( BPy_FalseUP0D* self, PyObject *args) +{ + if(!( PyArg_ParseTuple(args, "") )) + return -1; + self->py_up0D.up0D = new Predicates0D::FalseUP0D(); + return 0; +} /*-----------------------BPy_FalseUP0D type definition ------------------------------*/ @@ -33,7 +49,7 @@ PyTypeObject FalseUP0D_Type = { 0, /* tp_setattro */ 0, /* tp_as_buffer */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ - "FalseUP0D objects", /* tp_doc */ + FalseUP0D___doc__, /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ @@ -53,16 +69,6 @@ PyTypeObject FalseUP0D_Type = { 0, /* tp_new */ }; -//------------------------INSTANCE METHODS ---------------------------------- - -int FalseUP0D___init__( BPy_FalseUP0D* self, PyObject *args) -{ - if(!( PyArg_ParseTuple(args, "") )) - return -1; - self->py_up0D.up0D = new Predicates0D::FalseUP0D(); - return 0; -} - /////////////////////////////////////////////////////////////////////////////////////////// #ifdef __cplusplus diff --git a/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_TrueUP0D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_TrueUP0D.cpp index f5745df534b..9097f4e38bc 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_TrueUP0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate0D/BPy_TrueUP0D.cpp @@ -6,8 +6,25 @@ extern "C" { /////////////////////////////////////////////////////////////////////////////////////////// -/*--------------- Python API function prototypes for TrueUP0D instance -----------*/ -static int TrueUP0D___init__(BPy_TrueUP0D* self, PyObject *args); +//------------------------INSTANCE METHODS ---------------------------------- + +static char TrueUP0D___doc__[] = +".. method:: __call__(it)\n" +"\n" +" Always returns true.\n" +"\n" +" :arg it: An Interface0DIterator object.\n" +" :type it: :class:`Interface0DIterator`\n" +" :return: True.\n" +" :rtype: bool\n"; + +static int TrueUP0D___init__( BPy_TrueUP0D* self, PyObject *args ) +{ + if(!( PyArg_ParseTuple(args, "") )) + return -1; + self->py_up0D.up0D = new Predicates0D::TrueUP0D(); + return 0; +} /*-----------------------BPy_TrueUP0D type definition ------------------------------*/ @@ -32,7 +49,7 @@ PyTypeObject TrueUP0D_Type = { 0, /* tp_setattro */ 0, /* tp_as_buffer */ Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ - "TrueUP0D objects", /* tp_doc */ + TrueUP0D___doc__, /* tp_doc */ 0, /* tp_traverse */ 0, /* tp_clear */ 0, /* tp_richcompare */ @@ -52,16 +69,6 @@ PyTypeObject TrueUP0D_Type = { 0, /* tp_new */ }; -//------------------------INSTANCE METHODS ---------------------------------- - -int TrueUP0D___init__( BPy_TrueUP0D* self, PyObject *args ) -{ - if(!( PyArg_ParseTuple(args, "") )) - return -1; - self->py_up0D.up0D = new Predicates0D::TrueUP0D(); - return 0; -} - /////////////////////////////////////////////////////////////////////////////////////////// #ifdef __cplusplus -- cgit v1.2.3