[gnue] r7463 - in trunk/gnue-appserver/src: . gcd generator gld

[reinhard]

Author: reinhard
Date: 2005-04-22 11:54:38 -0500 (Fri, 22 Apr 2005)
New Revision: 7463

Modified:
   trunk/gnue-appserver/src/data.py
   trunk/gnue-appserver/src/gcd/readgcd.py
   trunk/gnue-appserver/src/geasConfiguration.py
   trunk/gnue-appserver/src/geasGsdGen.py
   trunk/gnue-appserver/src/geasRpcServer.py
   trunk/gnue-appserver/src/generator/layout.py
   trunk/gnue-appserver/src/gld/GLParser.py
   trunk/gnue-appserver/src/gld/readgld.py
Log:
Epydoc fixes.


Modified: trunk/gnue-appserver/src/data.py
===================================================================
--- trunk/gnue-appserver/src/data.py    2005-04-22 16:23:38 UTC (rev 7462)
+++ trunk/gnue-appserver/src/data.py    2005-04-22 16:54:38 UTC (rev 7463)
@@ -457,12 +457,14 @@
     """
     Returns the state of the given record. Returns one of the following 
results:
 
-      'initializing': newly created record with initialization not yet finished
-      'initialized': newly created and initialized records with no 
modifications
-      'inserted': newly created record with modifications
-      'changed': existing record with modifications
-      'deleted': deleted record
-      'clean': record is available and has no modifications
+      - 'initializing': newly created record with initialization not yet
+        finished
+      - 'initialized': newly created and initialized records with no
+        modifications
+      - 'inserted': newly created record with modifications
+      - 'changed': existing record with modifications
+      - 'deleted': deleted record
+      - 'clean': record is available and has no modifications
 
     @return: current state of the given (table, row) tuple in the cache
     """
@@ -1106,7 +1108,7 @@
     @param rows: sequence of tuples (table, rowid)
     @param constraints: dictionary with all constraints per row
 
-    @result: ordered sequence of tuples (table, rowid)
+    @return: ordered sequence of tuples (table, rowid)
 
     @raises CircularReferenceError: if the given data contains reference cycles
     """
@@ -1658,7 +1660,7 @@
     """
     This function creates a path to access a given property based on the
     content-dictionary. 
-    @param: property name including alias and fieldname, separated by a dot
+    @param name: property name including alias and fieldname, separated by a 
dot
     @return: sequence of tuples (alias, tablename, fieldname)
     """
 
@@ -1914,12 +1916,14 @@
     """
     Returns the state of the given record. Returns one of the following 
results:
 
-      'initializing': newly created record with initialization not yet finished
-      'initialized': newly created and initialized records with no 
modifications
-      'inserted': newly created record with modifications
-      'changed': existing record with modifications
-      'deleted': deleted record
-      'clean': record is available and has no modifications
+      - 'initializing': newly created record with initialization not yet
+        finished
+      - 'initialized': newly created and initialized records with no
+        modifications
+      - 'inserted': newly created record with modifications
+      - 'changed': existing record with modifications
+      - 'deleted': deleted record
+      - 'clean': record is available and has no modifications
 
     @return: current state of the record
     """

Modified: trunk/gnue-appserver/src/gcd/readgcd.py
===================================================================
--- trunk/gnue-appserver/src/gcd/readgcd.py     2005-04-22 16:23:38 UTC (rev 
7462)
+++ trunk/gnue-appserver/src/gcd/readgcd.py     2005-04-22 16:54:38 UTC (rev 
7463)
@@ -26,6 +26,7 @@
 import string
 
 from gnue.common.apps import i18n, errors
+from gnue.common.apps.i18n import translate as _        # for epydoc
 from gnue.common.apps.GClientApp import *
 from gnue.common.utils.FileUtils import openResource
 from gnue.common.datasources import GDataSource

Modified: trunk/gnue-appserver/src/geasConfiguration.py
===================================================================
--- trunk/gnue-appserver/src/geasConfiguration.py       2005-04-22 16:23:38 UTC 
(rev 7462)
+++ trunk/gnue-appserver/src/geasConfiguration.py       2005-04-22 16:54:38 UTC 
(rev 7463)
@@ -23,8 +23,9 @@
 
 import os.path
 
+from gnue import paths
+from gnue.common.apps.i18n import translate as _        # for epydoc
 from gnue.common.formatting import GTypecast
-from gnue import paths
 
 
 ConfigOptions = (

Modified: trunk/gnue-appserver/src/geasGsdGen.py
===================================================================
--- trunk/gnue-appserver/src/geasGsdGen.py      2005-04-22 16:23:38 UTC (rev 
7462)
+++ trunk/gnue-appserver/src/geasGsdGen.py      2005-04-22 16:54:38 UTC (rev 
7463)
@@ -31,6 +31,7 @@
   import datetime
 
 from gnue.common.apps import i18n, errors
+from gnue.common.apps.i18n import translate as _        # for epydoc
 from gnue.common.schema import Objects
 from gnue.common.apps.GClientApp import *
 from gnue.common.datasources import GDataSource, GConditions
@@ -679,9 +680,11 @@
 
     If destination-relation is None, destination-item is a field-value
     otherwise it's a field-name. 
-    Examples: (foo, bar, foobar, barbaz) means foo.bar = foobar.barbaz
-              (foo, bar, None, barbaz)   means foo.bar = barbaz
 
+    Examples:
+      - (foo, bar, foobar, barbaz) means foo.bar = foobar.barbaz
+      - (foo, bar, None, barbaz)   means foo.bar = barbaz
+
     @return: dictionary with conditions
     """
 

Modified: trunk/gnue-appserver/src/geasRpcServer.py
===================================================================
--- trunk/gnue-appserver/src/geasRpcServer.py   2005-04-22 16:23:38 UTC (rev 
7462)
+++ trunk/gnue-appserver/src/geasRpcServer.py   2005-04-22 16:54:38 UTC (rev 
7463)
@@ -29,6 +29,7 @@
 import gnue.paths
 
 from gnue.common.apps import GConfig, i18n
+from gnue.common.apps.i18n import translate as _        # for epydoc
 from gnue.common.apps.GServerApp import GServerApp
 from gnue.common.datasources import GLoginHandler
 from gnue.common.rpc import server

Modified: trunk/gnue-appserver/src/generator/layout.py
===================================================================
--- trunk/gnue-appserver/src/generator/layout.py        2005-04-22 16:23:38 UTC 
(rev 7462)
+++ trunk/gnue-appserver/src/generator/layout.py        2005-04-22 16:54:38 UTC 
(rev 7463)
@@ -31,11 +31,6 @@
 
 class Manager:
 
-  _SPECIALS = {'gnue_createdate': {'Label': u_("Created"),
-                                   'Buddy': 'gnue_createuser'},
-               'gnue_modifydate': {'Label': u_("Last modified"),
-                                   'Buddy': 'gnue_modifyuser'}}
-
   # ---------------------------------------------------------------------------
   # Constructor
   # ---------------------------------------------------------------------------
@@ -47,6 +42,11 @@
     @param maxHeight: maximum height for a form
     """
 
+    self._SPECIALS = {'gnue_createdate': {'Label': u_("Created"),
+                                          'Buddy': 'gnue_createuser'},
+                      'gnue_modifydate': {'Label': u_("Last modified"),
+                                          'Buddy': 'gnue_modifyuser'}}
+
     self._maxWidth   = maxWidth
     self._maxHeight  = maxHeight
     self._classdef   = classdef

Modified: trunk/gnue-appserver/src/gld/GLParser.py
===================================================================
--- trunk/gnue-appserver/src/gld/GLParser.py    2005-04-22 16:23:38 UTC (rev 
7462)
+++ trunk/gnue-appserver/src/gld/GLParser.py    2005-04-22 16:54:38 UTC (rev 
7463)
@@ -21,6 +21,7 @@
 #
 # $Id$
 
+from gnue.common.apps import errors
 from gnue.common.definitions import GParser, GObjects, GRootObj
 from gnue.common.definitions.GParserHelpers import GContent
 from gnue.common.formatting import GTypecast
@@ -32,7 +33,7 @@
 # Exceptions
 # =============================================================================
 
-class Error (gException):
+class Error (errors.gException):
   pass
 
 class NoModuleError (Error):

Modified: trunk/gnue-appserver/src/gld/readgld.py
===================================================================
--- trunk/gnue-appserver/src/gld/readgld.py     2005-04-22 16:23:38 UTC (rev 
7462)
+++ trunk/gnue-appserver/src/gld/readgld.py     2005-04-22 16:54:38 UTC (rev 
7463)
@@ -26,6 +26,7 @@
 import string
 
 from gnue.common.apps import GClientApp, i18n, errors
+from gnue.common.apps.i18n import translate as _        # for epydoc
 from gnue.common.utils.FileUtils import openResource
 from gnue.common.datasources import GDataSource, GConditions
 from gnue.common.utils.uuid import UUID
@@ -459,7 +460,7 @@
     This function creates a lookup dictionary for modules. It's a mapping for
     id to name and vice versa.
 
-    @result: dictionary with id-to-name and name-to-id maps for modules
+    @return: dictionary with id-to-name and name-to-id maps for modules
     """
     
     result = {}