diff options
author | Campbell Barton <ideasman42@gmail.com> | 2008-10-15 02:31:10 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2008-10-15 02:31:10 +0400 |
commit | 8fcaa1782ddd9d7fecc2c8a3549c4250aa2ef91d (patch) | |
tree | d725007a787ee4f6d22f33bb9dc110b1fbed4d53 /source/blender/python | |
parent | dcda0b9d867b233f3780fd8e48da89fecf334604 (diff) |
cleanup epydoc errors
Diffstat (limited to 'source/blender/python')
-rw-r--r-- | source/blender/python/api2_2x/doc/BGL.py | 68 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/IpoCurve.py | 38 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Noise.py | 6 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Particle.py | 3 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Text.py | 2 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/Texture.py | 4 | ||||
-rw-r--r-- | source/blender/python/api2_2x/doc/epy_docgen.sh | 2 |
7 files changed, 60 insertions, 63 deletions
diff --git a/source/blender/python/api2_2x/doc/BGL.py b/source/blender/python/api2_2x/doc/BGL.py index 661042f341b..4a10de4a05c 100644 --- a/source/blender/python/api2_2x/doc/BGL.py +++ b/source/blender/python/api2_2x/doc/BGL.py @@ -146,11 +146,11 @@ def glBitmap(width, height, xorig, yorig, xmove, ymove, bitmap): @type width, height: int @param width, height: Specify the pixel width and height of the bitmap image. - @type xorig,yorig: float - @param xorig,yorig: Specify the location of the origin in the bitmap image. The origin is measured + @type xorig, yorig: float + @param xorig, yorig: Specify the location of the origin in the bitmap image. The origin is measured from the lower left corner of the bitmap, with right and up being the positive axes. - @type xmove,ymove: float - @param xmove,ymove: Specify the x and y offsets to be added to the current raster position after + @type xmove, ymove: float + @param xmove, ymove: Specify the x and y offsets to be added to the current raster position after the bitmap is drawn. @type bitmap: Buffer object I{type GL_BYTE} @param bitmap: Specifies the address of the bitmap image. @@ -207,8 +207,8 @@ def glClearAccum(red, green, blue, alpha): Specify clear values for the accumulation buffer @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/clearaccum.html} - @type red,green,blue,alpha: float - @param red,green,blue,alpha: Specify the red, green, blue, and alpha values used when the + @type red, green, blue, alpha: float + @param red, green, blue, alpha: Specify the red, green, blue, and alpha values used when the accumulation buffer is cleared. The initial values are all 0. """ @@ -217,8 +217,8 @@ def glClearColor(red, green, blue, alpha): Specify clear values for the color buffers @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/clearcolor.html} - @type red,green,blue,alpha: float - @param red,green,blue,alpha: Specify the red, green, blue, and alpha values used when the + @type red, green, blue, alpha: float + @param red, green, blue, alpha: Specify the red, green, blue, and alpha values used when the color buffers are cleared. The initial values are all 0. """ @@ -274,8 +274,8 @@ def glColor (red, green, blue, alpha): Set a new color. @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/color.html} - @type red,green,blue,alpha: Depends on function prototype. - @param red,green,blue: Specify new red, green, and blue values for the current color. + @type red, green, blue, alpha: Depends on function prototype. + @param red, green, blue: Specify new red, green, and blue values for the current color. @param alpha: Specifies a new alpha value for the current color. Included only in the four-argument glColor4 commands. (With '4' colors only) """ @@ -285,8 +285,8 @@ def glColorMask(red, green, blue, alpha): Enable and disable writing of frame buffer color components @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/colormask.html} - @type red,green,blue,alpha: int (boolean) - @param red,green,blue,alpha: Specify whether red, green, blue, and alpha can or cannot be + @type red, green, blue, alpha: int (boolean) + @param red, green, blue, alpha: Specify whether red, green, blue, and alpha can or cannot be written into the frame buffer. The initial values are all GL_TRUE, indicating that the color components can be written. """ @@ -308,8 +308,8 @@ def glCopyPixels(x, y, width, height, type): Copy pixels in the frame buffer @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/copypixels.html} - @type x,y: int - @param x,y: Specify the window coordinates of the lower left corner of the rectangular + @type x, y: int + @param x, y: Specify the window coordinates of the lower left corner of the rectangular region of pixels to be copied. @type width, height: int @param width,height: Specify the dimensions of the rectangular region of pixels to be copied. @@ -1079,7 +1079,7 @@ def glNormal3 (nx, ny, nz, v): @param nx, ny, nz: Specify the x, y, and z coordinates of the new current normal. The initial value of the current normal is the unit vector, (0, 0, 1). @type v: Buffer object. Depends on function prototype. ('v' prototypes) - @param v: Specifies a pointer to an array of three elements: the x,y, and z coordinates + @param v: Specifies a pointer to an array of three elements: the x, y, and z coordinates of the new current normal. """ @@ -1290,7 +1290,7 @@ def glRasterPos (x,y,z,w): @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/rasterpos.html} @type x, y, z, w: Depends on function prototype. (z and w for '3' and '4' prototypes only) - @param x,y,z,w: Specify the x,y,z, and w object coordinates (if present) for the + @param x, y, z, w: Specify the x,y,z, and w object coordinates (if present) for the raster position. If function prototype ends in 'v' specifies a pointer to an array of two, three, or four elements, specifying x, y, z, and w coordinates, respectively. @note: @@ -1326,8 +1326,8 @@ def glReadPixels(x, y, width, height, format, type, pixels): Read a block of pixels from the frame buffer @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/readpixels.html} - @type x,y: int - @param x,y:Specify the window coordinates of the first pixel that is read + @type x, y: int + @param x, y:Specify the window coordinates of the first pixel that is read from the frame buffer. This location is the lower left corner of a rectangular block of pixels. @type width, height: int @@ -1375,8 +1375,8 @@ def glRotate (angle, x, y, z): @type angle: Depends on function prototype. @param angle: Specifies the angle of rotation in degrees. - @type x,y,z: Depends on function prototype. - @param x,y,z: Specify the x,y, and z coordinates of a vector respectively. + @type x, y, z: Depends on function prototype. + @param x, y, z: Specify the x, y, and z coordinates of a vector respectively. """ def glScale (x,y,z): @@ -1386,8 +1386,8 @@ def glScale (x,y,z): Multiply the current matrix by a general scaling matrix @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/scale.html} - @type x,y,z: Depends on function prototype. - @param x,y,z: Specify scale factors along the x,y, and z axes, respectively. + @type x, y, z: Depends on function prototype. + @param x, y, z: Specify scale factors along the x, y, and z axes, respectively. """ def glScissor(x,y,width,height): @@ -1395,8 +1395,8 @@ def glScissor(x,y,width,height): Define the scissor box @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/scissor.html} - @type x,y: int - @param x,y: Specify the lower left corner of the scissor box. Initially (0, 0). + @type x, y: int + @param x, y: Specify the lower left corner of the scissor box. Initially (0, 0). @type width, height: int @param width height: Specify the width and height of the scissor box. When a GL context is first attached to a window, width and height are set to the @@ -1480,8 +1480,8 @@ def glTexCoord (s,t,r,q,v): Set the current texture coordinates @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/texcoord.html} - @type s,t,r,q: Depends on function prototype. (r and q for '3' and '4' prototypes only) - @param s,t,r,q: Specify s, t, r, and q texture coordinates. Not all parameters are + @type s, t, r, q: Depends on function prototype. (r and q for '3' and '4' prototypes only) + @param s, t, r, q: Specify s, t, r, and q texture coordinates. Not all parameters are present in all forms of the command. @type v: Buffer object. Depends on function prototype. (for 'v' prototypes only) @param v: Specifies a pointer to an array of one, two, three, or four elements, @@ -1604,8 +1604,8 @@ def glTranslate (x, y, z): Multiply the current matrix by a translation matrix @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/translate.html} - @type x,y,z: Depends on function prototype. - @param x,y,z: Specify the x, y, and z coordinates of a translation vector. + @type x, y, z: Depends on function prototype. + @param x, y, z: Specify the x, y, and z coordinates of a translation vector. """ def glVertex (x,y,z,w,v): @@ -1618,8 +1618,8 @@ def glVertex (x,y,z,w,v): Specify a vertex @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/vertex.html} - @type x,y,z,w: Depends on function prototype (z and w for '3' and '4' prototypes only) - @param x,y,z,w: Specify x, y, z, and w coordinates of a vertex. Not all parameters + @type x, y, z, w: Depends on function prototype (z and w for '3' and '4' prototypes only) + @param x, y, z, w: Specify x, y, z, and w coordinates of a vertex. Not all parameters are present in all forms of the command. @type v: Buffer object. Depends of function prototype (for 'v' prototypes only) @param v: Specifies a pointer to an array of two, three, or four elements. The @@ -1632,11 +1632,11 @@ def glViewport(x,y,width,height): Set the viewport @see: U{www.opengl.org/documentation/specs/man_pages/hardcopy/GL/html/gl/viewport.html} - @type x,y: int - @param x,y: Specify the lower left corner of the viewport rectangle, + @type x, y: int + @param x, y: Specify the lower left corner of the viewport rectangle, in pixels. The initial value is (0,0). - @type width,height: int - @param width,height: Specify the width and height of the viewport. When a GL context + @type width, height: int + @param width, height: Specify the width and height of the viewport. When a GL context is first attached to a window, width and height are set to the dimensions of that window. """ diff --git a/source/blender/python/api2_2x/doc/IpoCurve.py b/source/blender/python/api2_2x/doc/IpoCurve.py index 7b4a2db9929..850a1825325 100644 --- a/source/blender/python/api2_2x/doc/IpoCurve.py +++ b/source/blender/python/api2_2x/doc/IpoCurve.py @@ -16,7 +16,7 @@ BezTriples. Example:: import Blender ipo = Blender.Ipo.Get('ObIpo') # retrieves an Ipo object - ipo.name = 'ipo1' # change the Ipo's name + ipo.name = 'ipo1' # change the Ipo's name icu = ipo[Blender.Ipo.OB_LOCX] # request X Location Ipo curve object if icu != None and len(icu.bezierPoints) > 0: # if curve exists and has BezTriple points val = icu[2.5] # get the curve's value at time 2.5 @@ -78,27 +78,27 @@ class IpoCurve: get the value of the final curve point, read the final point from the curve:: - ipo = Blender.Object.Get('Cube').ipo - icu = ipo['LocX'] - endtime,endvalue = icu.bezierPoints[-1].pt + ipo = Blender.Object.Get('Cube').ipo + icu = ipo['LocX'] + endtime,endvalue = icu.bezierPoints[-1].pt @type extend: int """ def __getitem__ (time): - """ - Returns the value of the curve at a particular time. + """ + Returns the value of the curve at a particular time. @type time: float @param time: time (Vertex X) on the curve @rtype: float @return: value (Vertex Y) corresponding to the given time - """ + """ def __setitem__ (time): - """ - Sets the value (Vertex Y) of the curve at a particular time. + """ + Sets the value (Vertex Y) of the curve at a particular time. @type time: float @param time: time (Vertex X) on the curve - """ + """ def setExtrapolation(extendmode): """ @@ -217,16 +217,16 @@ class IpoCurve: """ def clean( thresh=0.0000001 ): - """ - Calls the IPO-curve cleaning function on this IpoCurve. - There is no need to recalculate curve manually. - @type thresh: float - @param thresh: The threshold to used to determine if two values are identical. - By default, the IPO-editor tool's value is used. - @rtype: None + """ + Calls the IPO-curve cleaning function on this IpoCurve. + There is no need to recalculate curve manually. + @type thresh: float + @param thresh: The threshold to used to determine if two values are identical. + By default, the IPO-editor tool's value is used. + @rtype: None @return: None - """ - + """ + def evaluate( time ): """ Compute the value of the Ipo curve at a particular time (B{deprecated}). diff --git a/source/blender/python/api2_2x/doc/Noise.py b/source/blender/python/api2_2x/doc/Noise.py index 5a246031fd0..122fdd3eda1 100644 --- a/source/blender/python/api2_2x/doc/Noise.py +++ b/source/blender/python/api2_2x/doc/Noise.py @@ -128,11 +128,9 @@ def turbulence (xyz, octaves, hard, basis = NoiseTypes['STDPERLIN'], @return: the generated turbulence value. """ -def vTurbulence (xyz, octaves, hard, basis = NoiseTypes['STDPERLIN'], - ampscale = 0.5, freqscale = 2.0): +def vTurbulence (xyz, octaves, hard, basis = NoiseTypes['STDPERLIN'], ampscale = 0.5, freqscale = 2.0): """ - Returns general turbulence vector using the optional specified noise basis -function. + Returns general turbulence vector using the optional specified noise basis function. @type xyz: 3-float tuple @param xyz: (x,y,z) float values. @type octaves: int diff --git a/source/blender/python/api2_2x/doc/Particle.py b/source/blender/python/api2_2x/doc/Particle.py index 511ad81b45f..cf662d9147a 100644 --- a/source/blender/python/api2_2x/doc/Particle.py +++ b/source/blender/python/api2_2x/doc/Particle.py @@ -131,8 +131,7 @@ class Particle: Get the particles locations. A list of tuple is returned in particle mode. A list of list of tuple is returned in hair mode. - The tuple is a vector of 3 or 4 floats in world space (x,y,z, -optionally the particle's id). + The tuple is a vector of 3 or 4 floats in world space (x,y,z, optionally the particle's id). @type all: int @param all: if not 0 export all particles (uninitialized (unborn or died)particles exported as None). @type id: int diff --git a/source/blender/python/api2_2x/doc/Text.py b/source/blender/python/api2_2x/doc/Text.py index 022205573aa..3093b636658 100644 --- a/source/blender/python/api2_2x/doc/Text.py +++ b/source/blender/python/api2_2x/doc/Text.py @@ -143,7 +143,7 @@ class Text: Retrieve the contents of this Text buffer as a list of strings between the start and end lines specified. If end < 0 all lines from start will be included. - @type start int + @type start: int @param start: Optional index of first line of the span to return @type end int @param end: Optional index of the line to which the span is taken or diff --git a/source/blender/python/api2_2x/doc/Texture.py b/source/blender/python/api2_2x/doc/Texture.py index b5b82b1a519..ad57c303ed2 100644 --- a/source/blender/python/api2_2x/doc/Texture.py +++ b/source/blender/python/api2_2x/doc/Texture.py @@ -432,9 +432,9 @@ class Texture: def setFlags(f1=None, f2=None, f3=None, f4=None): """ Set this object's flags. - @param f1,f2,f3,f4: Flags to be set (omitted flags are cleared). Can be any of + @param f1, f2, f3, f4: Flags to be set (omitted flags are cleared). Can be any of 'FlipBlendXY', 'NegAlpha', 'CheckerOdd', and 'CheckerEven' - @type f1,f2,f3,f4: string + @type f1, f2, f3, f4: string """ def setImage(image): diff --git a/source/blender/python/api2_2x/doc/epy_docgen.sh b/source/blender/python/api2_2x/doc/epy_docgen.sh index 8cbebf82f8d..0e5350e41ae 100644 --- a/source/blender/python/api2_2x/doc/epy_docgen.sh +++ b/source/blender/python/api2_2x/doc/epy_docgen.sh @@ -7,5 +7,5 @@ # set posix locale so regex works properly for [A-Z]*.py LC_ALL=POSIX -epydoc -v -o BPY_API --url "http://www.blender.org" --top API_intro \ +epydoc --debug -v -o BPY_API --url "http://www.blender.org" --top API_intro \ --name "Blender" --no-private --no-frames [A-Z]*.py |