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.
This commit is contained in:
@@ -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.
|
||||
"""
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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):
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
@@ -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.
|
||||
"""
|
||||
|
||||
|
||||
@@ -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
|
||||
"""
|
||||
|
||||
@@ -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 )
|
||||
|
||||
Reference in New Issue
Block a user