[pygccxml-commit] source/pyplusplus/experimental pypp_api.py,1.11,1.12

[Matthias B. <mb...@us...>]

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

Modified Files:
	pypp_api.py 
Log Message:
Added some more documentation

Index: pypp_api.py
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/experimental/pypp_api.py,v
retrieving revision 1.11
retrieving revision 1.12
diff -C2 -d -r1.11 -r1.12
*** pypp_api.py	22 Mar 2006 10:45:32 -0000	1.11
--- pypp_api.py	24 Mar 2006 17:29:16 -0000	1.12
***************
*** 5,10 ****
  
  __doc__ = """
- pypp api
- ========
  
  This module provides a simplified high-level API for using
--- 5,8 ----
***************
*** 12,21 ****
  
  Quickstart Usage
! ----------------
  
- Add quickstart here
  
  Detailed Usage
! --------------
  
  Add detailed usage here.
--- 10,42 ----
  
  Quickstart Usage
! ================
! 
!  1. Create an instance of the L{ModuleBuilder} class that serves as main
!     entry point for controlling pygccxml and pyplusplus. Parameters for
!     configuring pygccxml/pyplusplus can be passed in the constructor::
! 
!       from pypp_api import *
!    
!       mb = ModuleBuilder(...)
! 
!  2. Parse the header files using L{parse()<ModuleBuilder.parse>} and
!     customize your bindings::
! 
!       toplevel_namespace = mb.parse()
! 
!       MyClass = toplevel_namespace.Class("MyClass")
!       MyClass.expose()
! 
!       MyClass.Method("foo").setPolicy(return_internal_reference())
!       ...
! 
!  3. Write the C++ source files using
!     L{writeModule()<ModuleBuilder.writeModule>}::
! 
!       mb.writeModule()
  
  
  Detailed Usage
! ==============
  
  Add detailed usage here.