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.

1 files changed, 34 insertions, 16 deletions

diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp
index b297be28d70..ebc27787776 100644
--- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp
+++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp
@@ -6,8 +6,39 @@ extern "C" {
 
 ///////////////////////////////////////////////////////////////////////////////////////////
 
-/*---------------  Python API function prototypes for QuantitativeInvisibilityUP1D instance  -----------*/
-static int QuantitativeInvisibilityUP1D___init__(BPy_QuantitativeInvisibilityUP1D* self, PyObject *args );
+//------------------------INSTANCE METHODS ----------------------------------
+
+static char QuantitativeInvisibilityUP1D___doc__[] =
+".. method:: __init__(qi=0)\n"
+"\n"
+"   Builds a QuantitativeInvisibilityUP1D object.\n"
+"\n"
+"   :arg qi: The Quantitative Invisibility you want the Interface1D to\n"
+"      have.\n"
+"   :type qi: int\n"
+"\n"
+".. method:: __call__(inter)\n"
+"\n"
+"   Returns true if the Quantitative Invisibility evaluated at an\n"
+"   Interface1D, using the :class:`QuantitativeInvisibilityF1D`\n"
+"   functor, equals a certain user-defined value.\n"
+"\n"
+"   :arg inter: An Interface1D object.\n"
+"   :type inter: :class:`Interface1D`\n"
+"   :return: True if Quantitative Invisibility equals a user-defined\n"
+"      value.\n"
+"   :rtype: bool\n";
+
+static int QuantitativeInvisibilityUP1D___init__( BPy_QuantitativeInvisibilityUP1D* self, PyObject *args )
+{
+	int i = 0;
+
+	if( !PyArg_ParseTuple(args, "|i", &i) )
+		return -1;
+	
+	self->py_up1D.up1D = new Predicates1D::QuantitativeInvisibilityUP1D(i);
+	return 0;
+}
 
 /*-----------------------BPy_QuantitativeInvisibilityUP1D type definition ------------------------------*/
 
@@ -32,7 +63,7 @@ PyTypeObject QuantitativeInvisibilityUP1D_Type = {
 	0,                              /* tp_setattro */
 	0,                              /* tp_as_buffer */
 	Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */
-	"QuantitativeInvisibilityUP1D objects", /* tp_doc */
+	QuantitativeInvisibilityUP1D___doc__, /* tp_doc */
 	0,                              /* tp_traverse */
 	0,                              /* tp_clear */
 	0,                              /* tp_richcompare */
@@ -52,19 +83,6 @@ PyTypeObject QuantitativeInvisibilityUP1D_Type = {
 	0,                              /* tp_new */
 };
 
-//------------------------INSTANCE METHODS ----------------------------------
-
-int QuantitativeInvisibilityUP1D___init__( BPy_QuantitativeInvisibilityUP1D* self, PyObject *args )
-{
-	int i = 0;
-
-	if( !PyArg_ParseTuple(args, "|i", &i) )
-		return -1;
-	
-	self->py_up1D.up1D = new Predicates1D::QuantitativeInvisibilityUP1D(i);
-	return 0;
-}
-
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 #ifdef __cplusplus