Update of /cvsroot/pygccxml/source/pyplusplus/experimental
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4703
Modified Files:
pypp_api.py
Log Message:
Added some more doc strings
Index: pypp_api.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/experimental/pypp_api.py,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -d -r1.10 -r1.11
*** pypp_api.py 20 Mar 2006 14:21:32 -0000 1.10
--- pypp_api.py 22 Mar 2006 10:45:32 -0000 1.11
***************
*** 72,75 ****
--- 72,76 ----
@group Control methods: parse, buildCreators, writeModule
+ @group Customizing output: addInclude, setLicense, Template, addStartText, addEndText, addBodyTailText
"""
def __init__(self,
***************
*** 396,402 ****
def addInclude(self, headers):
! """ Add additional include file(s).
! These are not parsed but are just added to the generated code.
! Takes either a single header or a list of headers.
"""
if not isinstance(headers, list):
--- 397,407 ----
def addInclude(self, headers):
! """Add additional include file(s).
!
! These are not parsed but are just added to the generated code.
! Takes either a single header or a list of headers.
!
! @param headers: Header name(s)
! @type headers: str or list of str
"""
if not isinstance(headers, list):
***************
*** 418,426 ****
--- 423,453 ----
# This set of methods needs further refinement based upon user needs
def addBodyTailText(self, text):
+ """Add C++ source code to the module initialization function.
+
+ @param text: A string containing valid C++ source code.
+ @type text: str
+ """
self.addBodyTailCreator(code_creators.custom_text_t(text) )
def addStartText(self, text):
+ """Add C++ source code to the beginning of the main source file.
+
+ @param text: A string containing valid C++ source code.
+ @type text: str
+ """
self.addStartCreator(code_creators.custom_text_t(text) )
+ def addEndText(self, text):
+ """Add C++ source code to the end of the main source file.
+
+ @param text: A string containing valid C++ source code.
+ @type text: str
+ """
+ self.addEndCreator(code_creators.custom_text_t(text) )
+
+ def setLicense(self, licenseText):
+ """ Set the license header to use. """
+ self.mLicense = licenseText
+
def addStartCreator(self, creator):
self.mStartCreators.append(creator)
***************
*** 429,442 ****
self.mBodyTailCreators.append(creator)
- def addEndText(self, text):
- self.addEndCreator(code_creators.custom_text_t(text) )
-
def addEndCreator(self, creator):
self.mEndCreators.append(creator)
!
! def setLicense(self, licenseText):
! """ Set the license header to use. """
! self.mLicense = licenseText
!
# ---------- Internal helpers ----------- #
def buildTemplateFileContents(self):
--- 456,462 ----
self.mBodyTailCreators.append(creator)
def addEndCreator(self, creator):
self.mEndCreators.append(creator)
!
# ---------- Internal helpers ----------- #
def buildTemplateFileContents(self):
|
