Miscellaneous fixes to documentation.

This commit is contained in:
Ken Hughes 2006-04-21 20:31:27 +00:00
parent 4aa28f13f4
commit 1e1e908816
2 changed files with 5 additions and 5 deletions

@ -11,7 +11,7 @@ data blocks.
- MESH - the key is a Mesh key; data blocks contain - MESH - the key is a Mesh key; data blocks contain
L{NMVert<NMesh.NMVert>} vertices. L{NMVert<NMesh.NMVert>} vertices.
- CURVE - the key is a Curve key; data blocks contains either - CURVE - the key is a Curve key; data blocks contains either
L{BezTriples<Ipo.BezTriple>} or points (represented by a list of L{BezTriples<BezTriple.BezTriple>} or points (represented by a list of
3 floating point numbers). 3 floating point numbers).
- LATTICE - the key is a Lattice key; data blocks contain - LATTICE - the key is a Lattice key; data blocks contain
BPoints, each point represented by a list of 3 floating point numbers. BPoints, each point represented by a list of 3 floating point numbers.
@ -97,7 +97,7 @@ class KeyBlock:
don't have corresponding Python objects yet, so each BPoint is don't have corresponding Python objects yet, so each BPoint is
represented using a list of three floating-point numbers (the represented using a list of three floating-point numbers (the
coordinate for each lattice vertex). coordinate for each lattice vertex).
- Curve keys return either a list of L{BezTriple<Ipo.BezTriple>} - Curve keys return either a list of L{BezTriple<BezTriple.BezTriple>}
objects in the data if the curve is a Bezier curve, otherwise it objects in the data if the curve is a Bezier curve, otherwise it
returns lists of three floats for each NURB or poly coordinate. returns lists of three floats for each NURB or poly coordinate.
""" """

@ -113,7 +113,7 @@ class Action:
Get the Ipo for the named channel in this action Get the Ipo for the named channel in this action
@type channel: string @type channel: string
@param channel: The name of a channel in this action @param channel: The name of a channel in this action
@rtype: PyIpo @rtype: PyIpo or None
@return: the Ipo for the channel @return: the Ipo for the channel
""" """
@ -127,6 +127,6 @@ class Action:
def getAllChannelIpos(): def getAllChannelIpos():
""" """
Get the all the Ipos for this action Get the all the Ipos for this action
@rtype: Dictionary [channel : PyIpo] @rtype: Dictionary [channel : PyIpo or None]
@return: the Ipos for all the channels in the action @return: the Ipos for all the channels in the action
""" """