better __docfilter__ and other epydoc tweaks

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@26986 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

wxPython/contrib/activex/activex.i

@@ -25,7 +25,7 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
 

wxPython/contrib/gizmos/gizmos.i

@@ -36,7 +36,7 @@
 %import windows.i
 %import controls.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 
 MAKE_CONST_WXSTRING2(DynamicSashNameStr,     wxT("dynamicSashWindow"));

wxPython/contrib/glcanvas/glcanvas.i

@@ -25,7 +25,7 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 
 MAKE_CONST_WXSTRING2(GLCanvasNameStr, wxT("GLCanvas"));

wxPython/contrib/iewin/iewin.i

@@ -25,7 +25,7 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
 

wxPython/contrib/ogl/ogl.i

@@ -24,7 +24,7 @@
 
 %import windows.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);

wxPython/contrib/stc/stc.i

@@ -25,7 +25,7 @@
 %import core.i
 %import misc.i  // for DnD
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 MAKE_CONST_WXSTRING(STCNameStr);
 

wxPython/contrib/xrc/xrc.i

@@ -27,7 +27,7 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);

wxPython/src/__init__.py

@@ -26,7 +26,16 @@ __all__ = [
     'calendar',
     'grid',
     'html',
-    'wizard',    
+    'wizard',
+
+    # contribs (need a better way to find these...)
+    'activex',
+    'gizmos',
+    'glcanvas',
+    'iewin',
+    'ogl',
+    'stc',
+    'xrc',
     ]
 
 # Load the package namespace with the core classes and such
@@ -36,7 +45,7 @@ del wx
 # Load up __all__ with all the names of items that should appear to be
 # defined in this pacakge so epydoc will document them that way.
 import wx._core
-__docfilter__ = wx._core.__docfilter__
+__docfilter__ = wx._core.__DocFilter(globals())
 
 __all__ += [name for name in dir(wx._core)
             if not (name.startswith('__') and name.endswith('__'))]

wxPython/src/_core_ex.py

@@ -222,14 +222,22 @@ class FutureCall:
 # documented (or will be) as part of the classes/functions/methods
 # where they should be used.
 
-def __docfilter__(name):
+class __DocFilter:
-    import types
+    """
-    obj = globals().get(name, None)
+    A filter for epydoc that only allows non-Ptr classes and
-    if type(obj) not in [type, types.ClassType, types.FunctionType, types.BuiltinFunctionType]:
+    fucntions, in order to reduce the clutter in the API docs.
-        return False
+    """
-    if name.startswith('_') or name.endswith('Ptr') or name.startswith('EVT'):
+    def __init__(self, globals):
-        return False
+        self._globals = globals
-    return True
+        
+    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
 
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------

wxPython/src/calendar.i

@@ -24,7 +24,7 @@
 
 %import misc.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 %include _calendar_rename.i
 

wxPython/src/controls.i

@@ -23,7 +23,6 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include __controls_rename.i
 

wxPython/src/gdi.i

@@ -24,7 +24,6 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include __gdi_rename.i
 

wxPython/src/grid.i

@@ -27,7 +27,7 @@
 
 %import windows.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 
 %include _grid_rename.i

wxPython/src/html.i

@@ -30,7 +30,7 @@
 
 %import windows.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 %include _html_rename.i
 

wxPython/src/misc.i

@@ -25,7 +25,6 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include __misc_rename.i
 

wxPython/src/windows.i

@@ -24,7 +24,6 @@
 
 %import core.i
 %pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include __windows_rename.i
 

wxPython/src/wizard.i

@@ -25,6 +25,7 @@
 
 %import windows.i
 %pythoncode { wx = _core }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
 
 %include _wizard_rename.i
 

wxPython/wx/build/__init__.py

@@ -1 +1,20 @@
 # A Python package
+"""
+This package provides the config module, which is used by wxPython's
+setup.py distutils script.  It was moved here so it would be installed
+with the rest of wxPython and could therefore be used by the setup.py
+for other projects that needed this same info and functionality (most
+likely in order to be compatible with wxPython.)
+
+See config.py and wxPython's setup.py for more details.
+
+"""
+
+
+# Exclude config from the epydoc docs because it will currently cause
+# a lot of noise.  Once it has been refactored then add "config" to
+# the list below.
+
+__all__ = []
+
+

wxPython/wx/tools/__init__.py

@@ -1,4 +1,18 @@
-#
+"""
+Some useful tools and utilities for wxPython.
+"""
+
+
+# XRCed is purposfully left out so epydoc won't document it
+__all__ = [
+    'dbg',
+    'genaxmodule',
+    'helpviewer',
+    'img2img',
+    'img2png',
+    'img2py',
+    'img2xpm',
+    ]
 
 
 

wxPython/wx/tools/img2png.py

@@ -14,7 +14,7 @@
 #
 
 """
-img2png.py  -- convert several image formats to PNG format
+img2png.py  -- convert several image formats to PNG format.
 
 Usage:
 

wxPython/wx/tools/img2xpm.py

@@ -14,7 +14,7 @@
 #
 
 """
-img2xpm.py  -- convert several image formats to XPM
+img2xpm.py  -- convert several image formats to XPM.
 
 Usage: