Python API documentation updates: a description of class hierarchy

was added to the docstrings of most Python extension types.
This commit is contained in:
2010-08-12 12:17:47 +00:00
parent dd75ec4907
commit f510faed6c
133 changed files with 266 additions and 1 deletions

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char Curvature2DAngleF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`Curvature2DAngleF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a Curvature2DAngleF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char DensityF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`DensityF1D`\n"
"\n"
".. method:: __init__(sigma=2.0, iType=IntegrationType.MEAN, sampling=2.0)\n"
"\n"
" Builds a DensityF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetCompleteViewMapDensityF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetCompleteViewMapDensityF1D`\n"
"\n"
".. method:: __init__(level, iType=IntegrationType.MEAN, sampling=2.0)\n"
"\n"
" Builds a GetCompleteViewMapDensityF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetDirectionalViewMapDensityF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetDirectionalViewMapDensityF1D`\n"
"\n"
".. method:: __init__(iOrientation, level, iType=IntegrationType.MEAN, sampling=2.0)\n"
"\n"
" Builds a GetDirectionalViewMapDensityF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedXF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetProjectedXF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a GetProjectedXF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedYF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetProjectedYF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a GetProjectedYF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetProjectedZF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetProjectedZF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a GetProjectedZF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetSteerableViewMapDensityF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetSteerableViewMapDensityF1D`\n"
"\n"
".. method:: __init__(level, iType=IntegrationType.MEAN, sampling=2.0)\n"
"\n"
" Builds a GetSteerableViewMapDensityF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetViewMapGradientNormF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetViewMapGradientNormF1D`\n"
"\n"
".. method:: __init__()\n"
"\n"
" Builds a GetViewMapGradientNormF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetXF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetXF1D`\n"
"\n"
".. method:: __init__(iType)\n"
"\n"
" Builds a GetXF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetYF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetYF1D`\n"
"\n"
".. method:: __init__(iType)\n"
"\n"
" Builds a GetYF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char GetZF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`GetZF1D`\n"
"\n"
".. method:: __init__(iType)\n"
"\n"
" Builds a GetZF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char LocalAverageDepthF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`LocalAverageDepthF1D`\n"
"\n"
".. method:: __init__(sigma, iType=IntegrationType.MEAN)\n"
"\n"
" Builds a LocalAverageDepthF1D object.\n"

View File

@@ -13,6 +13,8 @@ extern "C" {
//------------------------INSTANCE METHODS ----------------------------------
static char ZDiscontinuityF1D___doc__[] =
"Class hierarchy: :class:`UnaryFunction1D` > :class:`UnaryFunction1DDouble` > :class:`ZDiscontinuityF1D`\n"
"\n"
".. method:: __init__(iType=IntegrationType.MEAN)\n"
"\n"
" Builds a ZDiscontinuityF1D object.\n"