%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
%import windows.i
%import controls.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING2(DynamicSashNameStr, wxT("dynamicSashWindow"));
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING2(GLCanvasNameStr, wxT("GLCanvas"));
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING_NOSWIG(PanelNameStr);
%import windows.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
%import core.i
%import misc.i // for DnD
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING(STCNameStr);
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
MAKE_CONST_WXSTRING_NOSWIG(EmptyString);
'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
# 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('__'))]
# 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
#----------------------------------------------------------------------------
#----------------------------------------------------------------------------
%import misc.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
%include _calendar_rename.i
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
%include __controls_rename.i
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
%include __gdi_rename.i
%import windows.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
%include _grid_rename.i
%import windows.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
%include _html_rename.i
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
%include __misc_rename.i
%import core.i
%pythoncode { wx = _core }
-%pythoncode { __docfilter__ = wx.__docfilter__ }
%include __windows_rename.i
%import windows.i
%pythoncode { wx = _core }
+%pythoncode { __docfilter__ = wx.__DocFilter(globals()) }
%include _wizard_rename.i
# 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__ = []
+
+
-#
+"""
+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',
+ ]
#
"""
-img2png.py -- convert several image formats to PNG format
+img2png.py -- convert several image formats to PNG format.
Usage:
#
"""
-img2xpm.py -- convert several image formats to XPM
+img2xpm.py -- convert several image formats to XPM.
Usage:
projects / wxWidgets.git / commitdiff
