Update of /cvsroot/pygccxml/source/pyplusplus/experimental
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16858
Modified Files:
pypp_api.py
Log Message:
Modified some doc strings so that epydoc doesn't generate warnings/errors anymore
Index: pypp_api.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/experimental/pypp_api.py,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** pypp_api.py 5 Mar 2006 00:50:54 -0000 1.2
--- pypp_api.py 8 Mar 2006 09:34:54 -0000 1.3
***************
*** 71,77 ****
defines=[], undefines=[],
cacheFile = None, verbose=True):
! """
! Initialize module.
! :Parameters:
- 'workingDir': directory to start processing. (default: current working dir)
- 'includePaths': List of paths to tell gccxml to search for header files.
--- 71,77 ----
defines=[], undefines=[],
cacheFile = None, verbose=True):
! """Initialize module.
!
! :Parameters:
- 'workingDir': directory to start processing. (default: current working dir)
- 'includePaths': List of paths to tell gccxml to search for header files.
***************
*** 265,269 ****
# ------------- Creator methods -------------- #
def Template(self, templateType, typedefName=None):
! """ Add a template to instantiate.
:param templateType: Fully instantiated name. (ex: TemplateClass<float> )
:param typedefName: Name of type def to define to this template type.
--- 265,270 ----
# ------------- Creator methods -------------- #
def Template(self, templateType, typedefName=None):
! """Add a template to instantiate.
!
:param templateType: Fully instantiated name. (ex: TemplateClass<float> )
:param typedefName: Name of type def to define to this template type.
***************
*** 520,525 ****
# --------- Internal helpers --------- #
def findContainedDecls(self, name=None, declType=None):
! """
! Search contained declarations for ones of specific type and or name.
:param name: regex to use for matching. (can just be full name)
:param declType: a single type or a list of decl types to look for.
--- 521,526 ----
# --------- Internal helpers --------- #
def findContainedDecls(self, name=None, declType=None):
! """Search contained declarations for ones of specific type and or name.
!
:param name: regex to use for matching. (can just be full name)
:param declType: a single type or a list of decl types to look for.
***************
*** 557,567 ****
! def findContainedMethod(self, name, retval=None, args=None):
"""Search for a method with a particular name.
name is the method name, retval the type of the return
value and args a list of argument types. All types (retval and args)
are given as strings treated as regex matches.
! ex: findContainedMethod("method", retval="bool &", args=["int", "float"])
! findContainedMethod(".*", retval="float", args=None)
"""
found = []
--- 558,570 ----
! 6
! def findContainedMethod(self, name, retval=None, args=None):
"""Search for a method with a particular name.
name is the method name, retval the type of the return
value and args a list of argument types. All types (retval and args)
are given as strings treated as regex matches.
! ex:
! findContainedMethod("method", retval="bool &", args=["int", "float"])
! findContainedMethod(".*", retval="float", args=None)
"""
found = []
|