[pygccxml-commit] source/pyplusplus/experimental pypp_api.py,1.4,1.5

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/pygccxml/source/pyplusplus/experimental
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15126

Modified Files:
	pypp_api.py 
Log Message:
1) Changed the 'declHeaders' argument in module_creator.create() into 'decl_headers' as it is defined in pyplusplus. 2) Switched to epytext as markup and modified the doc strings accordingly. 3) Modified some doc strings to remove epydoc warnings/errors.

Index: pypp_api.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/experimental/pypp_api.py,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** pypp_api.py	9 Mar 2006 01:49:56 -0000	1.4
--- pypp_api.py	9 Mar 2006 10:55:50 -0000	1.5
***************
*** 4,8 ****
  # http://www.boost.org/LICENSE_1_0.txt)

- __docformat__ = "restructuredtext en"
  __doc__ = """
  pypp api
--- 4,7 ----
***************
*** 22,30 ****
  Add detailed usage here.

! :todo: Add quickstart and detailed documentation for API.
! :author: Allen Bierbaum
! :author: Matthias Baas
! :license: Boost Software License, Version 1.0 (see http://www.boost.org/LICENSE_1_0.txt)
! :copyright: 2006 Allen Bierbaum, Matthias Baas
  """

--- 21,29 ----
  Add detailed usage here.

! @todo: Add quickstart and detailed documentation for API.
! @author: Allen Bierbaum
! @author: Matthias Baas
! @license: Boost Software License, Version 1.0 (see http://www.boost.org/LICENSE_1_0.txt)
! @copyright: 2006 Allen Bierbaum, Matthias Baas
  """

***************
*** 64,68 ****
        By default all declarations are ignored.

!       :todo:  Fix the parsing to work with recent changes

     """
--- 63,67 ----
        By default all declarations are ignored.

!       @todo:  Fix the parsing to work with recent changes

     """
***************
*** 73,83 ****
        """Initialize module.

!       :Parameters:
!             - 'workingDir':   directory to start processing.  (default: current working dir)
!             - 'includePaths': List of paths to tell gccxml to search for header files.
!             - 'gccxmlPath':   path to gccxml.  If not set then attempt to find it in system path.
!             - '(un)defines':  set of symbols to add as (un)defined when compiling.
!             - 'cacheFile':    name of file to use for caching parse data for this module.
!             - 'verbose':      if true output status and command information as building the module.
        """
        if not isinstance(headerFiles, list):
--- 72,82 ----
        """Initialize module.

!       @param workingDir: directory to start processing.  (default: current working dir)
!       @param includePaths: List of paths to tell gccxml to search for header files.
!       @param gccxmlPath: path to gccxml.  If not set then attempt to find it in system path.
!       @param defines: set of symbols to add as defined when compiling.
!       @param undefines: set of symbols to add as undefined when compiling.
!       @param cacheFile: name of file to use for caching parse data for this module.
!       @param verbose: if true output status and command information as building the module.
        """
        if not isinstance(headerFiles, list):
***************
*** 112,116 ****
            have been made.

!           :postcondition: This class can act as a wrapper for namespace("::") and all declarations are set to be ignored.
        """      
        if self.mVerbose:
--- 111,115 ----
            have been made.

!           @postcondition: This class can act as a wrapper for namespace("::") and all declarations are set to be ignored.
        """      
        if self.mVerbose:
***************
*** 202,206 ****
        # - override the header files in create since we already know what files we used.
        maker = module_creator.creator_t(self.mFinalDecls, module_name=moduleName)      
!       extmodule = maker.create(declHeaders=self.mHeaderFiles)

        # Handle the extra creators that need added
--- 201,205 ----
        # - override the header files in create since we already know what files we used.
        maker = module_creator.creator_t(self.mFinalDecls, module_name=moduleName)      
!       extmodule = maker.create(decl_headers=self.mHeaderFiles)

        # Handle the extra creators that need added
***************
*** 236,244 ****
        """ Create the module and write it out.
            Automatically calls createCreators() and filterExposed() if needed.
!           :arg moduleName: The name of the module being created.
!           :arg filename:   The file or directory to create the code.
!           :arg useScope:   If true the creators all use scope in their code.
!           :arg multiFile:  If true use the multifile writer.
!           :arg multiCreateMain: If true and using multifile then create main reg method.
        """
        if not self.mExtModule:
--- 235,244 ----
        """ Create the module and write it out.
            Automatically calls createCreators() and filterExposed() if needed.
!           
!           @param moduleName: The name of the module being created.
!           @param filename:   The file or directory to create the code.
!           @param useScope:   If true the creators all use scope in their code.
!           @param multiFile:  If true use the multifile writer.
!           @param multiCreateMain: If true and using multifile then create main reg method.
        """
        if not self.mExtModule:
***************
*** 267,274 ****
        """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.
!                     This name can then be used later to look up the real fully
!                     expanded template type from the typedef map. (see self.mTypeDefMap)
        """
        if not typedefName:
--- 267,274 ----
        """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.
!           This name can then be used later to look up the real fully
!           expanded template type from the typedef map. (see self.mTypeDefMap)
        """
        if not typedefName:
***************
*** 351,355 ****
         on an existing wrapper or on a module.

!        :todo: Rewrite methods to use new wrappers.
     """
     def __init__(self, decl):
--- 351,355 ----
         on an existing wrapper or on a module.

!        @todo: Rewrite methods to use new wrappers.
     """
     def __init__(self, decl):
***************
*** 444,448 ****
     def setCallPolicy(self, callPolicy):
        """ Set the callpolicy of the contained method.
!           :arg callPolicy: Callpolicy object to use (must be of type decl_wrappers.call_policy_t)
        """
        assert isinstance(callPolicy, decl_wrappers.call_policy_t)
--- 444,449 ----
     def setCallPolicy(self, callPolicy):
        """ Set the callpolicy of the contained method.
!       
!           @param callPolicy: Callpolicy object to use (must be of type decl_wrappers.call_policy_t)
        """
        assert isinstance(callPolicy, decl_wrappers.call_policy_t)
***************
*** 523,530 ****
        """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.
!          :return: None if not found.  Returns 1 or a list if found.
!          :note: To make name lookup more predictable matching we automatically add
               a '$' to the end of the regex to match the end of the name.
               This helps to prevent names with similar prefix's from matching.
--- 524,531 ----
        """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.
!       @return: None if not found.  Returns 1 or a list if found.
!       @note: To make name lookup more predictable matching we automatically add
               a '$' to the end of the regex to match the end of the name.
               This helps to prevent names with similar prefix's from matching.
***************
*** 545,550 ****
     def findContained(self, name=None, declType=None):
        """ Return a new DeclWrapper or MultiDeclWrapper for matching decls.
!           :arg name:     If set this regex is used.
!           :arg declType: If set restrict search to decls based on the given type.
        """
        found = self.findContainedDecls(name, declType)
--- 546,552 ----
     def findContained(self, name=None, declType=None):
        """ Return a new DeclWrapper or MultiDeclWrapper for matching decls.
!       
!           @param name:     If set this regex is used.
!           @param declType: If set restrict search to decls based on the given type.
        """
        found = self.findContainedDecls(name, declType)