Added bash versions of my build scripts and updated BUILD.txt for how

[wxWidgets.git] / wxPython / src / _core_ex.py

diff --git a/wxPython/src/_core_ex.py b/wxPython/src/_core_ex.py
index 6c6ff3b1f9ec882b8ea6e0ce2cd77c9f98c87369..d9d121fa52d4c184f4bb069e4f5979c57e19d310 100644 (file)
--- a/wxPython/src/_core_ex.py
+++ b/wxPython/src/_core_ex.py
@@ -96,7 +96,10 @@ def CallAfter(callable, *args, **kw):
     """
     Call the specified function after the current and pending event
     handlers have been completed.  This is also good for making GUI
     """
     Call the specified function after the current and pending event
     handlers have been completed.  This is also good for making GUI

-    method calls from non-GUI threads.
+    method calls from non-GUI threads.  Any extra positional or
+    keyword args are passed on to the callable when it is called.
+
+    :see: `wx.FutureCall`

     """
     app = wx.GetApp()
     assert app, 'No wxApp created yet'
     """
     app = wx.GetApp()
     assert app, 'No wxApp created yet'


@@ -122,7 +125,7 @@ class FutureCall:
     A convenience class for wx.Timer, that calls the given callable
     object once after the given amount of milliseconds, passing any
     positional or keyword args.  The return value of the callable is
     A convenience class for wx.Timer, that calls the given callable
     object once after the given amount of milliseconds, passing any
     positional or keyword args.  The return value of the callable is

-    availbale after it has been run with the GetResult method.
+    availbale after it has been run with the `GetResult` method.

 
     If you don't need to get the return value or restart the timer
     then there is no need to hold a reference to this object.  It will
 
     If you don't need to get the return value or restart the timer
     then there is no need to hold a reference to this object.  It will


@@ -130,6 +133,8 @@ class FutureCall:
     has a reference to self.Notify) but the cycle will be broken when
     the timer completes, automatically cleaning up the wx.FutureCall
     object.
     has a reference to self.Notify) but the cycle will be broken when
     the timer completes, automatically cleaning up the wx.FutureCall
     object.

+
+    :see: `wx.CallAfter`

     """
     def __init__(self, millis, callable, *args, **kwargs):
         self.millis = millis
     """
     def __init__(self, millis, callable, *args, **kwargs):
         self.millis = millis


@@ -222,14 +227,22 @@ class FutureCall:
 # documented (or will be) as part of the classes/functions/methods
 # where they should be used.
 
 # documented (or will be) as part of the classes/functions/methods
 # where they should be used.
 

-def __docfilter__(name):
-    import types
-    obj = globals().get(name, None)
-    if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
-        return False
-    if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
-        return False
-    return True
+class __DocFilter:
+    """
+    A filter for epydoc that only allows non-Ptr classes and
+    fucntions, in order to reduce the clutter in the API docs.
+    """
+    def __init__(self, globals):
+        self._globals = globals
+        
+    def __call__(self, name):
+        import types
+        obj = self._globals.get(name, None)
+        if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
+            return False
+        if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
+            return False
+        return True

 
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------
 
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------