Python API documentation updates: a description of class hierarchy

was added to the docstrings of most Python extension types.

7 files changed, 14 insertions, 0 deletions

diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp
index 943b4fb5e46..a7b710f796b 100644
--- a/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/BPy_FEdge.cpp
@@ -15,6 +15,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 	
 static char FEdge___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`FEdge`\n"
+"\n"
 "Base Class for feature edges.  This FEdge can represent a silhouette,\n"
 "a crease, a ridge/valley, a border or a suggestive contour.  For\n"
 "silhouettes, the FEdge is oriented so that the visible face lies on\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp
index d939e18fb3d..5b20db3a267 100644
--- a/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/BPy_FrsCurve.cpp
@@ -14,6 +14,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char FrsCurve___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`Curve`\n"
+"\n"
 "Base class for curves made of CurvePoints.  :class:`SVertex` is the\n"
 "type of the initial curve vertices.  A :class:`Chain` is a\n"
 "specialization of a Curve.\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp
index 4edcc52fabf..7edfde7e8f6 100644
--- a/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/BPy_Stroke.cpp
@@ -22,6 +22,8 @@ extern "C" {
 //     - is it even used ? not even in SWIG version
 
 static char Stroke___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`Stroke`\n"
+"\n"
 "Class to define a stroke.  A stroke is made of a set of 2D vertices\n"
 "(:class:`StrokeVertex`), regularly spaced out.  This set of vertices\n"
 "defines the stroke's backbone geometry.  Each of these stroke vertices\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp b/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp
index 49ef52f87aa..e35ea82ace2 100644
--- a/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/BPy_ViewEdge.cpp
@@ -17,6 +17,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 	
 static char ViewEdge___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`ViewEdge`\n"
+"\n"
 "Class defining a ViewEdge.  A ViewEdge in an edge of the image graph.\n"
 "it connnects two :class:`ViewVertex` objects.  It is made by connecting\n"
 "a set of FEdges.\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp b/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp
index 7958a35b851..c85134f71d5 100644
--- a/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/Curve/BPy_Chain.cpp
@@ -13,6 +13,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char Chain___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`Curve` > :class:`Chain`\n"
+"\n"
 "Class to represent a 1D elements issued from the chaining process.  A\n"
 "Chain is the last step before the :class:`Stroke` and is used in the\n"
 "Splitting and Creation processes.\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp
index f98b6f49940..ec49167b0c1 100644
--- a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSharp.cpp
@@ -12,6 +12,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char FEdgeSharp___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`FEdge` > :class:`FEdgeSharp`\n"
+"\n"
 "Class defining a sharp FEdge.  A Sharp FEdge corresponds to an initial\n"
 "edge of the input mesh.  It can be a silhouette, a crease or a border.\n"
 "If it is a crease edge, then it is borded by two faces of the mesh.\n"
diff --git a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp
index 3e043108d98..df945b1e6a8 100644
--- a/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp
+++ b/source/blender/freestyle/intern/python/Interface1D/FEdge/BPy_FEdgeSmooth.cpp
@@ -12,6 +12,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char FEdgeSmooth___doc__[] =
+"Class hierarchy: :class:`Interface1D` > :class:`FEdge` > :class:`FEdgeSmooth`\n"
+"\n"
 "Class defining a smooth edge.  This kind of edge typically runs across\n"
 "a face of the input mesh.  It can be a silhouette, a ridge or valley,\n"
 "a suggestive contour.\n"