From f510faed6cb982bc98d3049a78e1ab27ddd9cc16 Mon Sep 17 00:00:00 2001 From: Tamito Kajiyama Date: Thu, 12 Aug 2010 12:17:47 +0000 Subject: Python API documentation updates: a description of class hierarchy was added to the docstrings of most Python extension types. --- .../blender/freestyle/intern/python/BinaryPredicate1D/BPy_FalseBP1D.cpp | 2 ++ .../freestyle/intern/python/BinaryPredicate1D/BPy_Length2DBP1D.cpp | 2 ++ .../freestyle/intern/python/BinaryPredicate1D/BPy_SameShapeIdBP1D.cpp | 2 ++ .../blender/freestyle/intern/python/BinaryPredicate1D/BPy_TrueBP1D.cpp | 2 ++ .../intern/python/BinaryPredicate1D/BPy_ViewMapGradientNormBP1D.cpp | 2 ++ 5 files changed, 10 insertions(+) (limited to 'source/blender/freestyle/intern/python/BinaryPredicate1D') diff --git a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_FalseBP1D.cpp b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_FalseBP1D.cpp index 78566d915d6..ad2885fb95a 100644 --- a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_FalseBP1D.cpp +++ b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_FalseBP1D.cpp @@ -9,6 +9,8 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char FalseBP1D___doc__[] = +"Class hierarchy: :class:`BinaryPredicate1D` > :class:`FalseBP1D`\n" +"\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Always returns false.\n" diff --git a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_Length2DBP1D.cpp b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_Length2DBP1D.cpp index 5249e2ba6b0..1a59091c453 100644 --- a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_Length2DBP1D.cpp +++ b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_Length2DBP1D.cpp @@ -9,6 +9,8 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char Length2DBP1D___doc__[] = +"Class hierarchy: :class:`BinaryPredicate1D` > :class:`Length2DBP1D`\n" +"\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Returns true if the 2D length of inter1 is less than the 2D length\n" diff --git a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_SameShapeIdBP1D.cpp b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_SameShapeIdBP1D.cpp index 5255752ff71..2b479a49fc0 100644 --- a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_SameShapeIdBP1D.cpp +++ b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_SameShapeIdBP1D.cpp @@ -9,6 +9,8 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char SameShapeIdBP1D___doc__[] = +"Class hierarchy: :class:`BinaryPredicate1D` > :class:`SameShapeIdBP1D`\n" +"\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Returns true if inter1 and inter2 belong to the same shape.\n" diff --git a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_TrueBP1D.cpp b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_TrueBP1D.cpp index 6df906a31d5..090a8232794 100644 --- a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_TrueBP1D.cpp +++ b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_TrueBP1D.cpp @@ -9,6 +9,8 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char TrueBP1D___doc__[] = +"Class hierarchy: :class:`BinaryPredicate1D` > :class:`TrueBP1D`\n" +"\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Always returns true.\n" diff --git a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_ViewMapGradientNormBP1D.cpp b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_ViewMapGradientNormBP1D.cpp index 5f433ae3e22..f5ba9d58d72 100644 --- a/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_ViewMapGradientNormBP1D.cpp +++ b/source/blender/freestyle/intern/python/BinaryPredicate1D/BPy_ViewMapGradientNormBP1D.cpp @@ -14,6 +14,8 @@ extern "C" { //ViewMapGradientNormBP1D(int level, IntegrationType iType=MEAN, float sampling=2.0) static char ViewMapGradientNormBP1D___doc__[] = +"Class hierarchy: :class:`BinaryPredicate1D` > :class:`ViewMapGradientNormBP1D`\n" +"\n" ".. method:: __call__(inter1, inter2)\n" "\n" " Returns true if the evaluation of the Gradient norm Function is\n" -- cgit v1.2.3