diff options
author | Tamito Kajiyama <rd6t-kjym@asahi-net.or.jp> | 2014-09-19 08:22:20 +0400 |
---|---|---|
committer | Tamito Kajiyama <rd6t-kjym@asahi-net.or.jp> | 2014-09-19 08:41:47 +0400 |
commit | 64ade99ecc0e9bd10332c90ae0f49cbc942443a7 (patch) | |
tree | 9c485bd85088a971ba6a4634c41968ae69c3ae4c /source/blender/freestyle/intern/python/UnaryPredicate1D | |
parent | 98a78963be78c1dfd02e1930e2db72deca121d1a (diff) |
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.
Diffstat (limited to 'source/blender/freestyle/intern/python/UnaryPredicate1D')
10 files changed, 25 insertions, 24 deletions
diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ContourUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ContourUP1D.cpp index 8365f9b832a..d0ced2ad4c3 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ContourUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ContourUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char ContourUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`ContourUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`ContourUP1D`\n" "\n" ".. method:: __call__(inter)\n" "\n" @@ -41,7 +41,7 @@ static char ContourUP1D___doc__[] = " contour if it is borded by a different shape on each of its sides.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if the Interface1D is a contour, false otherwise.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_DensityLowerThanUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_DensityLowerThanUP1D.cpp index b0bd67744c5..807d76f4731 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_DensityLowerThanUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_DensityLowerThanUP1D.cpp @@ -35,7 +35,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char DensityLowerThanUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`DensityLowerThanUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`DensityLowerThanUP1D`\n" "\n" ".. method:: __init__(threshold, sigma=2.0)\n" "\n" @@ -45,7 +45,7 @@ static char DensityLowerThanUP1D___doc__[] = " having a density lower than this threshold will match.\n" " :type threshold: float\n" " :arg sigma: The sigma value defining the density evaluation window\n" -" size used in the :class:`DensityF0D` functor.\n" +" size used in the :class:`freestyle.functions.DensityF0D` functor.\n" " :type sigma: float\n" "\n" ".. method:: __call__(inter)\n" @@ -54,7 +54,7 @@ static char DensityLowerThanUP1D___doc__[] = " than a user-defined density value.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if the density is lower than a threshold.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToChainingTimeStampUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToChainingTimeStampUP1D.cpp index 5cc5e0cf12a..f8a7ff8650c 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToChainingTimeStampUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToChainingTimeStampUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char EqualToChainingTimeStampUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`EqualToChainingTimeStampUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`freestyle.types.EqualToChainingTimeStampUP1D`\n" "\n" ".. method:: __init__(ts)\n" "\n" @@ -48,7 +48,7 @@ static char EqualToChainingTimeStampUP1D___doc__[] = " user-defined value.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if the time stamp is equal to a user-defined value.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToTimeStampUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToTimeStampUP1D.cpp index a2cafcf5fd2..ffed4f966e6 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToTimeStampUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_EqualToTimeStampUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char EqualToTimeStampUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`EqualToTimeStampUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`EqualToTimeStampUP1D`\n" "\n" ".. method:: __init__(ts)\n" "\n" @@ -48,7 +48,7 @@ static char EqualToTimeStampUP1D___doc__[] = " user-defined value.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if the time stamp is equal to a user-defined value.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ExternalContourUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ExternalContourUP1D.cpp index 486b020ef6a..140ebb86454 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ExternalContourUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ExternalContourUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char ExternalContourUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`ExternalContourUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`ExternalContourUP1D`\n" "\n" ".. method:: __call__(inter)\n" "\n" @@ -42,7 +42,7 @@ static char ExternalContourUP1D___doc__[] = " one of its sides.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if the Interface1D is an external contour, false\n" " otherwise.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_FalseUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_FalseUP1D.cpp index 098f449048e..2d1e99aed2b 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_FalseUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_FalseUP1D.cpp @@ -33,14 +33,14 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char FalseUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`FalseUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`FalseUP1D`\n" "\n" ".. method:: __call__(inter)\n" "\n" " Always returns false.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: False.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp index 143aac7d4c5..806ad8168ac 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_QuantitativeInvisibilityUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char QuantitativeInvisibilityUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`QuantitativeInvisibilityUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`QuantitativeInvisibilityUP1D`\n" "\n" ".. method:: __init__(qi=0)\n" "\n" @@ -46,11 +46,12 @@ static char QuantitativeInvisibilityUP1D___doc__[] = ".. method:: __call__(inter)\n" "\n" " Returns true if the Quantitative Invisibility evaluated at an\n" -" Interface1D, using the :class:`QuantitativeInvisibilityF1D`\n" -" functor, equals a certain user-defined value.\n" +" Interface1D, using the\n" +" :class:`freestyle.functions.QuantitativeInvisibilityF1D` functor,\n" +" equals a certain user-defined value.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if Quantitative Invisibility equals a user-defined\n" " value.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ShapeUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ShapeUP1D.cpp index 998d6b1ed61..93970972aac 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ShapeUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_ShapeUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char ShapeUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`ShapeUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`ShapeUP1D`\n" "\n" ".. method:: __init__(first, second=0)\n" "\n" @@ -46,11 +46,11 @@ static char ShapeUP1D___doc__[] = "\n" ".. method:: __call__(inter)\n" "\n" -" Returns true if the shape to which the Interface1D belongs to has\n" -" the same :class:`Id` as the one specified by the user.\n" +" Returns true if the shape to which the Interface1D belongs to has the\n" +" same :class:`freestyle.types.Id` as the one specified by the user.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True if Interface1D belongs to the shape of the\n" " user-specified Id.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_TrueUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_TrueUP1D.cpp index 8444fbfc365..d4ca82721d5 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_TrueUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_TrueUP1D.cpp @@ -33,14 +33,14 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char TrueUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`TrueUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`TrueUP1D`\n" "\n" ".. method:: __call__(inter)\n" "\n" " Always returns true.\n" "\n" " :arg inter: An Interface1D object.\n" -" :type inter: :class:`Interface1D`\n" +" :type inter: :class:`freestyle.types.Interface1D`\n" " :return: True.\n" " :rtype: bool\n"; diff --git a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_WithinImageBoundaryUP1D.cpp b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_WithinImageBoundaryUP1D.cpp index 7e310fe593d..6f08cd1c796 100644 --- a/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_WithinImageBoundaryUP1D.cpp +++ b/source/blender/freestyle/intern/python/UnaryPredicate1D/BPy_WithinImageBoundaryUP1D.cpp @@ -33,7 +33,7 @@ extern "C" { //------------------------INSTANCE METHODS ---------------------------------- static char WithinImageBoundaryUP1D___doc__[] = -"Class hierarchy: :class:`UnaryPredicate1D` > :class:`WithinImageBoundaryUP1D`\n" +"Class hierarchy: :class:`freestyle.types.UnaryPredicate1D` > :class:`WithinImageBoundaryUP1D`\n" "\n" ".. method:: __init__(xmin, ymin, xmax, ymax)\n" "\n" |