From db9f9215cfa1e7958b1b95713d026c91daff1214 Mon Sep 17 00:00:00 2001
From: Stephen Swaney <sswaney@centurytel.net>
Date: Fri, 5 Mar 2004 05:50:50 +0000
Subject: [PATCH] Fix for Bug 1045. Added more detail for method return types
in various doc files. Changed version number in epy_docgen.sh to BPY_API_232.
---
source/blender/python/api2_2x/doc/Armature.py | 2 +-
source/blender/python/api2_2x/doc/Curve.py | 2 +-
source/blender/python/api2_2x/doc/Ipo.py | 8 ++++----
source/blender/python/api2_2x/doc/Material.py | 4 ++--
source/blender/python/api2_2x/doc/NMesh.py | 2 +-
source/blender/python/api2_2x/doc/Scene.py | 2 +-
source/blender/python/api2_2x/doc/Text.py | 4 ++--
source/blender/python/api2_2x/doc/epy_docgen.sh | 2 +-
8 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/source/blender/python/api2_2x/doc/Armature.py b/source/blender/python/api2_2x/doc/Armature.py
index 31c0833b4d6..f883a8f1808 100644
--- a/source/blender/python/api2_2x/doc/Armature.py
+++ b/source/blender/python/api2_2x/doc/Armature.py
@@ -65,7 +65,7 @@ class Armature:
def getBones():
"""
Get the Armature root bones.
- @rtype: list
+ @rtype: list of Blender Bones
@return: a list of Armature bones.
"""
diff --git a/source/blender/python/api2_2x/doc/Curve.py b/source/blender/python/api2_2x/doc/Curve.py
index 3b057641d47..df50e08170a 100644
--- a/source/blender/python/api2_2x/doc/Curve.py
+++ b/source/blender/python/api2_2x/doc/Curve.py
@@ -211,7 +211,7 @@ class Curve:
Get the curve's control point value.
@type numcurve: int
@type numpoint: int
- @rtype: list
+ @rtype: list of floats
@return: depends upon the curve's type.
- type bezier : a list of three coordinates
- type nurbs : a list of nine coordinates.
diff --git a/source/blender/python/api2_2x/doc/Ipo.py b/source/blender/python/api2_2x/doc/Ipo.py
index e3cd01eca53..c6d88f55f34 100644
--- a/source/blender/python/api2_2x/doc/Ipo.py
+++ b/source/blender/python/api2_2x/doc/Ipo.py
@@ -58,7 +58,7 @@ class Ipo:
def getCurves():
"""
Gets all the IpoCurves of the Ipo.
- @rtype: list
+ @rtype: list of IpoCurves
@return: A list (possibly void) containing all the IpoCurves associated to the Ipo object.
"""
def getCurve(curvename):
@@ -237,7 +237,7 @@ class IpoCurve:
def getPoints():
"""
Returns all the points of the ipo curve.
- @rtype: list
+ @rtype: list of BezTriples
@return: the points of the ipo curve.
"""
@@ -254,8 +254,8 @@ class BezTriple:
def getPoints():
"""
Returns the xy coordinates of the Bezier point.
- @rtype: list
- @return: list of the coordinates of the Bezier point.
+ @rtype: list of floats
+ @return: list of the x and y coordinates of the Bezier point.
"""
def setPoints(newval):
diff --git a/source/blender/python/api2_2x/doc/Material.py b/source/blender/python/api2_2x/doc/Material.py
index 8bee2d85cd2..9212936926b 100644
--- a/source/blender/python/api2_2x/doc/Material.py
+++ b/source/blender/python/api2_2x/doc/Material.py
@@ -495,6 +495,6 @@ class Material:
def getTextures ():
"""
Get this Material's Texture list.
- @rtype: list
- @return: a list of Blender Textures. None is returned for each empty texture slot.
+ @rtype: list of MTex
+ @return: a list of Blender MTex objects. None is returned for each empty texture slot.
"""
diff --git a/source/blender/python/api2_2x/doc/NMesh.py b/source/blender/python/api2_2x/doc/NMesh.py
index 4e4680ef0cb..d7a087a30e4 100644
--- a/source/blender/python/api2_2x/doc/NMesh.py
+++ b/source/blender/python/api2_2x/doc/NMesh.py
@@ -320,7 +320,7 @@ class NMesh:
Get influences of bones in a specific vertex.
@type index: int
@param index: The index of a vertex.
- @rtype: list
+ @rtype: list of lists
@return: List of pairs (name, weight), where name is the bone name (string)
and its weight is a float value.
"""
diff --git a/source/blender/python/api2_2x/doc/Scene.py b/source/blender/python/api2_2x/doc/Scene.py
index a9fc8c65e4e..08ccdce9d2e 100644
--- a/source/blender/python/api2_2x/doc/Scene.py
+++ b/source/blender/python/api2_2x/doc/Scene.py
@@ -209,7 +209,7 @@ class Scene:
def getChildren():
"""
Get all objects linked to this Scene.
- @rtype: list
+ @rtype: list of Blender Objects
@return: A list with all Blender Objects linked to this Scene.
"""
diff --git a/source/blender/python/api2_2x/doc/Text.py b/source/blender/python/api2_2x/doc/Text.py
index 480bd0599ab..6f417df3cd2 100644
--- a/source/blender/python/api2_2x/doc/Text.py
+++ b/source/blender/python/api2_2x/doc/Text.py
@@ -122,6 +122,6 @@ class Text:
def asLines():
"""
Retrieve the contents of this Text buffer as a list of strings.
- @rtype: list
- @return: A list of strings.
+ @rtype: list of strings
+ @return: A list of strings, one for each line in the buffer
"""
diff --git a/source/blender/python/api2_2x/doc/epy_docgen.sh b/source/blender/python/api2_2x/doc/epy_docgen.sh
index 5fffe0b498f..5613f2d1ea3 100644
--- a/source/blender/python/api2_2x/doc/epy_docgen.sh
+++ b/source/blender/python/api2_2x/doc/epy_docgen.sh
@@ -4,6 +4,6 @@
# run from the doc directory containing the .py files
# usage: sh epy_docgen.sh
-epydoc -o BPY_API_230 --url "http://www.blender.org" -t Blender.py \
+epydoc -o BPY_API_232 --url "http://www.blender.org" -t Blender.py \
-n "Blender" --no-private --no-frames \
$( ls [A-Z]*.py )
--
GitLab