Python API documentation updates: a description of class hierarchy

was added to the docstrings of most Python extension types.

6 files changed, 12 insertions, 0 deletions

diff --git a/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp b/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp
index dd1f4a2efba..e213edd5c79 100644
--- a/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/BPy_CurvePoint.cpp
@@ -12,6 +12,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char CurvePoint___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`CurvePoint`\n"
+"\n"
 "Class to represent a point of a curve.  A CurvePoint can be any point\n"
 "of a 1D curve (it doesn't have to be a vertex of the curve).  Any\n"
 ":class:`Interface1D` is built upon ViewEdges, themselves built upon\n"
diff --git a/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp
index bf810e6458e..8f036233b63 100644
--- a/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/BPy_SVertex.cpp
@@ -11,6 +11,8 @@ extern "C" {
 ///////////////////////////////////////////////////////////////////////////////////////////
 
 static char SVertex___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`SVertex`\n"
+"\n"
 "Class to define a vertex of the embedding.\n"
 "\n"
 ".. method:: __init__()\n"
diff --git a/source/blender/freestyle/intern/python/Interface0D/BPy_ViewVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/BPy_ViewVertex.cpp
index 9b81ce56400..c1fe6875ea7 100644
--- a/source/blender/freestyle/intern/python/Interface0D/BPy_ViewVertex.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/BPy_ViewVertex.cpp
@@ -13,6 +13,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char ViewVertex___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex`\n"
+"\n"
 "Class to define a view vertex.  A view vertex is a feature vertex\n"
 "corresponding to a point of the image graph, where the characteristics\n"
 "of an edge (e.g., nature and visibility) might change.  A\n"
diff --git a/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp
index 750019f26ad..63a848a77b6 100644
--- a/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/CurvePoint/BPy_StrokeVertex.cpp
@@ -13,6 +13,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char StrokeVertex___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`CurvePoint` > :class:`StrokeVertex`\n"
+"\n"
 "Class to define a stroke vertex.\n"
 "\n"
 ".. method:: __init__()\n"
diff --git a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp
index c38c5734448..ebb2920353d 100644
--- a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_NonTVertex.cpp
@@ -12,6 +12,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char NonTVertex___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`NonTVertex`\n"
+"\n"
 "View vertex for corners, cusps, etc. associated to a single SVertex.\n"
 "Can be associated to 2 or more view edges.\n"
 "\n"
diff --git a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp
index 26ccc48820b..14add743a37 100644
--- a/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp
+++ b/source/blender/freestyle/intern/python/Interface0D/ViewVertex/BPy_TVertex.cpp
@@ -15,6 +15,8 @@ extern "C" {
 //------------------------INSTANCE METHODS ----------------------------------
 
 static char TVertex___doc__[] =
+"Class hierarchy: :class:`Interface0D` > :class:`ViewVertex` > :class:`TVertex`\n"
+"\n"
 "Class to define a T vertex, i.e. an intersection between two edges.\n"
 "It points towards two SVertex and four ViewEdges.  Among the\n"
 "ViewEdges, two are front and the other two are back.  Basically a\n"