From 64ade99ecc0e9bd10332c90ae0f49cbc942443a7 Mon Sep 17 00:00:00 2001 From: Tamito Kajiyama Date: Fri, 19 Sep 2014 13:22:20 +0900 Subject: Freestyle: Python API documentation updates. Fixed dead references of API identifiers (e.g., freestyle.types.Interface0D) due to relocations of the identifiers into submodules. Also made various minor revisions of mark-ups and typos. --- .../UnaryFunction0D_double/BPy_Curvature2DAngleF0D.cpp | 10 +++++----- .../UnaryFunction0D_double/BPy_DensityF0D.cpp | 11 ++++++----- .../UnaryFunction0D_double/BPy_GetProjectedXF0D.cpp | 6 +++--- .../UnaryFunction0D_double/BPy_GetProjectedYF0D.cpp | 6 +++--- .../UnaryFunction0D_double/BPy_GetProjectedZF0D.cpp | 6 +++--- .../UnaryFunction0D/UnaryFunction0D_double/BPy_GetXF0D.cpp | 6 +++--- .../UnaryFunction0D/UnaryFunction0D_double/BPy_GetYF0D.cpp | 6 +++--- .../UnaryFunction0D/UnaryFunction0D_double/BPy_GetZF0D.cpp | 6 +++--- .../UnaryFunction0D_double/BPy_LocalAverageDepthF0D.cpp | 11 ++++++----- .../UnaryFunction0D_double/BPy_ZDiscontinuityF0D.cpp | 14 +++++++------- 10 files changed, 42 insertions(+), 40 deletions(-) (limited to 'source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double') diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_Curvature2DAngleF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_Curvature2DAngleF0D.cpp index 3d343762b8e..55f7bab3bb3 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_Curvature2DAngleF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_Curvature2DAngleF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char Curvature2DAngleF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`Curvature2DAngleF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`Curvature2DAngleF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,13 +43,13 @@ static char Curvature2DAngleF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns a real value giving the 2D curvature (as an angle) of the\n" -" 1D element to which the :class:`Interface0D` pointed by the\n" -" Interface0DIterator belongs. The 2D curvature is evaluated at the\n" +" Returns a real value giving the 2D curvature (as an angle) of the 1D\n" +" element to which the :class:`freestyle.types.Interface0D` pointed by\n" +" the Interface0DIterator belongs. The 2D curvature is evaluated at the\n" " Interface0D.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The 2D curvature of the 1D element evaluated at the\n" " pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_DensityF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_DensityF0D.cpp index 84a3fd79608..2aac3f4f1f0 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_DensityF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_DensityF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char DensityF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`DensityF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`DensityF0D`\n" "\n" ".. method:: __init__(sigma=2.0)\n" "\n" @@ -49,12 +49,13 @@ static char DensityF0D___doc__[] = ".. method:: __call__(it)\n" "\n" " Returns the density of the (result) image evaluated at the\n" -" :class:`Interface0D` pointed by the Interface0DIterator. This\n" -" density is evaluated using a pixels square window around the\n" -" evaluation point and integrating these values using a gaussian.\n" +" :class:`freestyle.types.Interface0D` pointed by the\n" +" Interface0DIterator. This density is evaluated using a pixels square\n" +" window around the evaluation point and integrating these values using\n" +" a gaussian.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The density of the image evaluated at the pointed\n" " Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedXF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedXF0D.cpp index d901b245247..123772b3fc7 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedXF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedXF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetProjectedXF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedXF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetProjectedXF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetProjectedXF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the X 3D projected coordinate of the :class:`Interface0D`\n" +" Returns the X 3D projected coordinate of the :class:`freestyle.types.Interface0D`\n" " pointed by the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The X 3D projected coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedYF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedYF0D.cpp index 2d82182f011..f4e3d6ba76f 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedYF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedYF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetProjectedYF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedYF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetProjectedYF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetProjectedYF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the Y 3D projected coordinate of the :class:`Interface0D`\n" +" Returns the Y 3D projected coordinate of the :class:`freestyle.types.Interface0D`\n" " pointed by the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The Y 3D projected coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedZF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedZF0D.cpp index 9766985954b..116bb75fc55 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedZF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetProjectedZF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetProjectedZF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetProjectedZF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetProjectedZF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetProjectedZF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the Z 3D projected coordinate of the :class:`Interface0D`\n" +" Returns the Z 3D projected coordinate of the :class:`freestyle.types.Interface0D`\n" " pointed by the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The Z 3D projected coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetXF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetXF0D.cpp index 9ee87c63bdd..614e92cf7c2 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetXF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetXF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetXF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetXF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetXF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetXF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the X 3D coordinate of the :class:`Interface0D` pointed by\n" +" Returns the X 3D coordinate of the :class:`freestyle.types.Interface0D` pointed by\n" " the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The X 3D coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetYF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetYF0D.cpp index 90f8f74e989..1a953b9ebca 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetYF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetYF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetYF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetYF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetYF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetYF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the Y 3D coordinate of the :class:`Interface0D` pointed by\n" +" Returns the Y 3D coordinate of the :class:`freestyle.types.Interface0D` pointed by\n" " the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The Y 3D coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetZF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetZF0D.cpp index 8876f2200c2..c985e0f5c99 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetZF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_GetZF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char GetZF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`GetZF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`GetZF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -43,11 +43,11 @@ static char GetZF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the Z 3D coordinate of the :class:`Interface0D` pointed by\n" +" Returns the Z 3D coordinate of the :class:`freestyle.types.Interface0D` pointed by\n" " the Interface0DIterator.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The Z 3D coordinate of the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_LocalAverageDepthF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_LocalAverageDepthF0D.cpp index af5edb4eac7..3c7f3b412fe 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_LocalAverageDepthF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_LocalAverageDepthF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char LocalAverageDepthF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`LocalAverageDepthF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`LocalAverageDepthF0D`\n" "\n" ".. method:: __init__(mask_size=5.0)\n" "\n" @@ -46,12 +46,13 @@ static char LocalAverageDepthF0D___doc__[] = "\n" ".. method:: __call__(it)\n" "\n" -" Returns the average depth around the :class:`Interface0D` pointed\n" -" by the Interface0DIterator. The result is obtained by querying the\n" -" depth buffer on a window around that point.\n" +" Returns the average depth around the\n" +" :class:`freestyle.types.Interface0D` pointed by the\n" +" Interface0DIterator. The result is obtained by querying the depth\n" +" buffer on a window around that point.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The average depth around the pointed Interface0D.\n" " :rtype: float\n"; diff --git a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_ZDiscontinuityF0D.cpp b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_ZDiscontinuityF0D.cpp index b64f6c06e93..f0c58352f4a 100644 --- a/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_ZDiscontinuityF0D.cpp +++ b/source/blender/freestyle/intern/python/UnaryFunction0D/UnaryFunction0D_double/BPy_ZDiscontinuityF0D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char ZDiscontinuityF0D___doc__[] = -"Class hierarchy: :class:`UnaryFunction0D` > :class:`UnaryFunction0DDouble` > :class:`ZDiscontinuityF0D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryFunction0D` > :class:`freestyle.types.UnaryFunction0DDouble` > :class:`ZDiscontinuityF0D`\n" "\n" ".. method:: __init__()\n" "\n" @@ -44,14 +44,14 @@ static char ZDiscontinuityF0D___doc__[] = ".. method:: __call__(it)\n" "\n" " Returns a real value giving the distance between the\n" -" :class:`Interface0D` pointed by the Interface0DIterator and the\n" -" shape that lies behind (occludee). This distance is evaluated in\n" -" the camera space and normalized between 0 and 1. Therefore, if no\n" -" object is occluded by the shape to which the Interface0D belongs to,\n" -" 1 is returned.\n" +" :class:`freestyle.types.Interface0D` pointed by the\n" +" Interface0DIterator and the shape that lies behind (occludee). This\n" +" distance is evaluated in the camera space and normalized between 0 and\n" +" 1. Therefore, if no object is occluded by the shape to which the\n" +" Interface0D belongs to, 1 is returned.\n" "\n" " :arg it: An Interface0DIterator object.\n" -" :type it: :class:`Interface0DIterator`\n" +" :type it: :class:`freestyle.types.Interface0DIterator`\n" " :return: The normalized distance between the pointed Interface0D\n" " and the occludee.\n" " :rtype: float\n"; -- cgit v1.2.3