bugfix: #1322 minor tweaks to the documentation for Draw module.

Blender.Draw.Button() was not showing up.  Seems to be an epydoc
issue with Button() being both a module method and the name of a class.
I changed Button to Button_ and added a usage note.
Yes, this is lame.
This commit is contained in:
Stephen Swaney
2004-05-25 19:59:41 +00:00
parent 5e3a9c092a
commit 05e76c22b0

View File

@@ -124,9 +124,11 @@ def Create(value):
@return: The Button created.
"""
def Button(name, event, x, y, width, height, tooltip = None):
def Button_(name, event, x, y, width, height, tooltip = None):
"""
Create a new (push) Button object.
Create a new (push) Button object. Please note there is no '_' character at the end of 'Button'.
This is due to a bug in our doc generation program. Use Button(....) instead.
And stop laughing.
@type name: string
@param name: The string to display on the button.
@type event: int
@@ -363,8 +365,7 @@ def Scrollbar(event, x, y, width, height, initial, min, max, realtime = 1,
@return: The Button created.
"""
def Number(name, event, x, y, width, height, initial, min, max, realtime = 1,
tooltip = None):
def Number(name, event, x, y, width, height, initial, min, max, tooltip = None):
"""
Create a new Number Button object.
@type name: string
@@ -386,9 +387,6 @@ def Number(name, event, x, y, width, height, initial, min, max, realtime = 1,
@param initial: The initial value.
@param min: The minimum value.
@param max: The maximum value.
@type realtime: int
@param realtime: If non-zero (the default), the slider will emit events as
it is edited.
@type tooltip: string
@param tooltip: The button's tooltip (the string that appears when the mouse
is kept over the button).