Author: reinhard
Date: 2009-10-16 05:05:21 -0500 (Fri, 16 Oct 2009)
New Revision: 9975
Modified:
trunk/gnue-forms/src/GFForm.py
trunk/gnue-forms/src/uidrivers/_base/UIdriver.py
trunk/gnue-navigator/src/GNClient.py
trunk/gnue-reports/src/client/GRRunUI.py
Log:
Epydoc fixes.
Modified: trunk/gnue-forms/src/GFForm.py
===================================================================
--- trunk/gnue-forms/src/GFForm.py 2009-10-15 21:43:16 UTC (rev 9974)
+++ trunk/gnue-forms/src/GFForm.py 2009-10-16 10:05:21 UTC (rev 9975)
@@ -1624,7 +1624,7 @@
"""
Loads and activates a new form from a file.
- @param fileName: the name of the .gfd file to be displayed
+ @param filename: the name of the .gfd file to be displayed
@param parameters: dictionary of parameters to be passed to the newly
run form
"""
@@ -1640,18 +1640,12 @@
"""
Launches a new instance of GNUe-Reports, running a new report.
@param reportFile: the name of the .grd file to be processed
- @param parameters: dictionary of parameters to be passed
- to the newly run report
- @param **params:
- These roughly correspond to the ./gnue-reports options
- destination
- destinationType
- destinationOptions (dict)
- filter
- filterOptions (dict)
- sortoption
- includeStructuralComments
- omitGNUeXML
+ @param parameters: dictionary of parameters to be passed to the newly
+ run report
+ @param **params: These roughly correspond to the ./gnue-reports options
+ "destination", "destinationType", "destinationOptions" (dict),
+ "filter", "filterOptions" (dict), "sortoption",
+ "includeStructuralComments", and "omitGNUeXML".
@return: None
"""
Modified: trunk/gnue-forms/src/uidrivers/_base/UIdriver.py
===================================================================
--- trunk/gnue-forms/src/uidrivers/_base/UIdriver.py 2009-10-15 21:43:16 UTC
(rev 9974)
+++ trunk/gnue-forms/src/uidrivers/_base/UIdriver.py 2009-10-16 10:05:21 UTC
(rev 9975)
@@ -254,29 +254,30 @@
These field definitions are specified as follows:
A field definition is a tuple having these elements:
- - fieldlabel: This text will be used as label in the left column
- - fieldname: This is the key in the result-dictionary to contain the value
- entered by the user
- - fieldtype: Currently these types are supported:
- - label: The contents of 'fieldlabel' as static text
- - warning: The contents of 'fieldlabel' as static text, formatted as
- warning
- - string: A text entry control
- - password: A text entry control with obscured characters
- - dropdown: Foreach element given in 'elements' a separate ComboBox
- control will be created, where each one has it's own dictionary of
- allowed values. If a value is selected in one control, all others
- are synchronized to represent the same key-value.
- - default: Default value to use
- - masterfield: Used for 'dropdowns'. This item specifies another field
- definition acting as master field. If this master field is changed, the
- allowedValues of this dropdown will be changed accordingly. If a
- masterfield is specified the 'allowedValues' dictionaries are built
like
- {master1: {key: value, key: value, ...}, master2: {key: value, ...}}
- - elements: sequence of input element tuples (label, allowedValues). This
- is used for dropdowns only. 'label' will be used as ToolTip for the
- control and 'allowedValues' gives a dictionary with all valid keys to
- be selected in the dropdown.
+ - fieldlabel: This text will be used as label in the left column
+ - fieldname: This is the key in the result-dictionary to contain the
+ value entered by the user
+ - fieldtype: Currently these types are supported:
+ - label: The contents of 'fieldlabel' as static text
+ - warning: The contents of 'fieldlabel' as static text, formatted
+ as warning
+ - string: A text entry control
+ - password: A text entry control with obscured characters
+ - dropdown: Foreach element given in 'elements' a separate ComboBox
+ control will be created, where each one has it's own dictionary
+ of allowed values. If a value is selected in one control, all
+ others are synchronized to represent the same key-value.
+ - default: Default value to use
+ - masterfield: Used for 'dropdowns'. This item specifies another field
+ definition acting as master field. If this master field is changed,
+ the allowedValues of this dropdown will be changed accordingly. If
+ a masterfield is specified the 'allowedValues' dictionaries are
+ built like {master1: {key: value, key: value, ...}, master2: {key:
+ value, ...}}
+ - elements: sequence of input element tuples (label, allowedValues).
+ This is used for dropdowns only. 'label' will be used as ToolTip
+ for the control and 'allowedValues' gives a dictionary with all
+ valid keys to be selected in the dropdown.
@return: If closed by 'Ok' the result is a dictionary with all values
entered by the user, where the "fieldname"s will be used as keys. If the
Modified: trunk/gnue-navigator/src/GNClient.py
===================================================================
--- trunk/gnue-navigator/src/GNClient.py 2009-10-15 21:43:16 UTC (rev
9974)
+++ trunk/gnue-navigator/src/GNClient.py 2009-10-16 10:05:21 UTC (rev
9975)
@@ -28,6 +28,7 @@
from gnue.navigator.GNParser import loadProcesses
from gnue.navigator import Actions
from gnue.common.apps import errors
+from gnue.common.apps.i18n import utranslate as u_
from gnue.common.utils.FileUtils import openResource, dyn_import
from gnue.common.apps.GClientApp import *
from gnue import paths
@@ -65,7 +66,7 @@
COMMAND = "gnue-navigator"
NAME = "GNUe Navigator"
USAGE = "[options] file"
- SUMMARY = _("GNUe Navigator is the primary menuing interface to the GNU "
+ SUMMARY = u_("GNUe Navigator is the primary menuing interface to the GNU "
"Enterprise system.")
# ---------------------------------------------------------------------------
@@ -76,18 +77,18 @@
self.addCommandOption ('user_interface', 'u', 'interface', argument = "ui",
category = "ui",
- help = _("The name of the user interface to use to display the "
- "navigator. Currently supported interfaces are: wx, gtk2, "
- "win32, web and text"))
+ help = u_("The name of the user interface to use to display the "
+ "navigator. Currently supported interfaces are: wx, gtk2, "
+ "win32, web and text"))
self.addCommandOption ('no-splash', 's', category = "ui",
- help = _("Disables the splash screen"))
+ help = u_("Disables the splash screen"))
self.addCommandOption ('gnome_menu', None, 'install-gnome-menu',
- help = _('Installs a menu structure into your local GNOME session'))
+ help = u_('Installs a menu structure into your local GNOME session'))
self.addCommandOption ('kde_menu', None, 'install-kde-menu',
- help = _('Installs a menu structure into your local KDE session'))
+ help = u_('Installs a menu structure into your local KDE session'))
GClientApp.__init__ (self, connections, 'forms', ConfigOptions)
Modified: trunk/gnue-reports/src/client/GRRunUI.py
===================================================================
--- trunk/gnue-reports/src/client/GRRunUI.py 2009-10-15 21:43:16 UTC (rev
9974)
+++ trunk/gnue-reports/src/client/GRRunUI.py 2009-10-16 10:05:21 UTC (rev
9975)
@@ -26,6 +26,7 @@
import mx
from gnue.common.apps import errors
+from gnue.common.apps.i18n import utranslate as u_
from gnue.common.utils.FileUtils import dyn_import
from gnue.common.datasources.GLoginHandler import BasicLoginHandler
_______________________________________________
commit-gnue mailing list
commit-gnue@gnu.org
http://lists.gnu.org/mailman/listinfo/commit-gnue
