Add __docfilter__ to modules so epydoc doesn't generate docs for all

the SWIG crud in the modules it doesn't need to.

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

diff --git a/wxPython/contrib/activex/activex.i b/wxPython/contrib/activex/activex.i
index f77fead3ab1c2589b45a9baa5ebd0dd963ddfe90..907207f60a6632a501e0753d11d709afc842819c 100644 (file)
--- a/wxPython/contrib/activex/activex.i
+++ b/wxPython/contrib/activex/activex.i
@@ -25,6 +25,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
 

diff --git a/wxPython/contrib/gizmos/gizmos.i b/wxPython/contrib/gizmos/gizmos.i
index 89463e7978a4e2fa93cd7c6562a5cc0ee239d090..30ad7813ecbfe3cdfc7e472102eb8d61b66379d7 100644 (file)
--- a/wxPython/contrib/gizmos/gizmos.i
+++ b/wxPython/contrib/gizmos/gizmos.i
@@ -36,6 +36,7 @@
 %import windows.i
 %import controls.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 
 MAKE_CONST_WXSTRING2(DynamicSashNameStr,     wxT("dynamicSashWindow"));

diff --git a/wxPython/contrib/glcanvas/glcanvas.i b/wxPython/contrib/glcanvas/glcanvas.i
index 6f6f3708fa4651dbd6d17f6248769c62fafaf8b6..b403ce7854321e62ca04b256fb5a8f0ac46f3bca 100644 (file)
--- a/wxPython/contrib/glcanvas/glcanvas.i
+++ b/wxPython/contrib/glcanvas/glcanvas.i
@@ -25,6 +25,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 
 MAKE_CONST_WXSTRING2(GLCanvasNameStr, wxT("GLCanvas"));

diff --git a/wxPython/contrib/iewin/iewin.i b/wxPython/contrib/iewin/iewin.i
index 01764566aaae6f0108e50e14e3d8fb4b8427dd59..cac700966cd73a3f3f59d3fb08fe5dc9a0330841 100644 (file)
--- a/wxPython/contrib/iewin/iewin.i
+++ b/wxPython/contrib/iewin/iewin.i
@@ -25,6 +25,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
 

diff --git a/wxPython/contrib/ogl/ogl.i b/wxPython/contrib/ogl/ogl.i
index 1e91d0af7eb4547f2d79cf7436c197aba007a6ce..eb27e0a0419a272eb37986d8d6a54203e4f88e03 100644 (file)
--- a/wxPython/contrib/ogl/ogl.i
+++ b/wxPython/contrib/ogl/ogl.i
@@ -24,6 +24,7 @@
 
 %import windows.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);

diff --git a/wxPython/contrib/stc/stc.i b/wxPython/contrib/stc/stc.i
index 64d98e6d3c62ff357909782a3d07818f52713f1e..505e5c548d75b802437737c50396d41eb8725934 100644 (file)
--- a/wxPython/contrib/stc/stc.i
+++ b/wxPython/contrib/stc/stc.i
@@ -25,6 +25,7 @@
 %import core.i
 %import misc.i  // for DnD
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 MAKE_CONST_WXSTRING(STCNameStr);
 

diff --git a/wxPython/contrib/xrc/xrc.i b/wxPython/contrib/xrc/xrc.i
index 59d26bf353fcc50cf9ee98cd0296a527a04d0b4d..1ad4e7146910f3eefca2a040fb2d32925211ea4e 100644 (file)
--- a/wxPython/contrib/xrc/xrc.i
+++ b/wxPython/contrib/xrc/xrc.i
@@ -27,6 +27,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 
 MAKE_CONST_WXSTRING_NOSWIG(EmptyString);

diff --git a/wxPython/src/_core_ex.py b/wxPython/src/_core_ex.py
index 0bb3c2e8b4f75f8e03e59e5cfbb80d7afaba6090..fb51c89d6f5a35cf392cc43b8ce93ae20000f291 100644 (file)
--- a/wxPython/src/_core_ex.py
+++ b/wxPython/src/_core_ex.py
@@ -213,6 +213,24 @@ class FutureCall:
             wx.CallAfter(self.Stop)
 
 
+
+#----------------------------------------------------------------------------
+# Control which items in this module should be documented by epydoc.
+# We allow only classes and functions, which will help reduce the size
+# of the docs by filtering out the zillions of constants, EVT objects,
+# and etc that don't make much sense by themselves, but are instead
+# 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
+
 #----------------------------------------------------------------------------
 #----------------------------------------------------------------------------
 

diff --git a/wxPython/src/calendar.i b/wxPython/src/calendar.i
index 2d21139061f6e0d8a3c67a9a023a0da796efbefd..96ba7d9e13f8f0d999a980cf11bfc99668c23bbb 100644 (file)
--- a/wxPython/src/calendar.i
+++ b/wxPython/src/calendar.i
@@ -24,6 +24,7 @@
 
 %import misc.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _calendar_rename.i
 

diff --git a/wxPython/src/controls.i b/wxPython/src/controls.i
index db144659424cae500f6898767332168345b47b34..258bdbc095e5b62d6d0306b9f1c316d5c5ae3970 100644 (file)
--- a/wxPython/src/controls.i
+++ b/wxPython/src/controls.i
@@ -23,6 +23,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _controls_rename.i
 

diff --git a/wxPython/src/gdi.i b/wxPython/src/gdi.i
index 117e3705811e348d5bc82d8138a10bf0982c6f9d..93daf3fdb3228745e93525f022e61c5973334c30 100644 (file)
--- a/wxPython/src/gdi.i
+++ b/wxPython/src/gdi.i
@@ -24,6 +24,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _gdi_rename.i
 

diff --git a/wxPython/src/grid.i b/wxPython/src/grid.i
index 8abc7cc0a673cd7df4a170476b6772083c68218e..08ee4d60b61d2f48b71bfb9cf4359150cc03d853 100644 (file)
--- a/wxPython/src/grid.i
+++ b/wxPython/src/grid.i
@@ -27,6 +27,7 @@
 
 %import windows.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 
 %include _grid_rename.i

diff --git a/wxPython/src/html.i b/wxPython/src/html.i
index 5a8992e0eae3f17ebf1429b47b4fd2fcfef0dbdf..535ff6aeee4d04ab111394c785e84af42acf8d05 100644 (file)
--- a/wxPython/src/html.i
+++ b/wxPython/src/html.i
@@ -30,6 +30,7 @@
 
 %import windows.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _html_rename.i
 

diff --git a/wxPython/src/misc.i b/wxPython/src/misc.i
index 37342395a00ba00a2a05c7d4c0b5fa7fe6657b8c..1a1ed143faaa0b498ed34c5ab80e2f0287f60735 100644 (file)
--- a/wxPython/src/misc.i
+++ b/wxPython/src/misc.i
@@ -26,6 +26,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _misc_rename.i
 

diff --git a/wxPython/src/windows.i b/wxPython/src/windows.i
index 4510c4f996a43e8d463b12320fca54d516d82cda..570a95305f0761bceba5615709e41b6a300775c2 100644 (file)
--- a/wxPython/src/windows.i
+++ b/wxPython/src/windows.i
@@ -25,6 +25,7 @@
 
 %import core.i
 %pythoncode { wx = core }
+%pythoncode { __docfilter__ = wx.__docfilter__ }
 
 %include _windows_rename.i