[pygccxml-commit] source/pyplusplus/docs/tutorials module_builder.rest,1.3,1.4 tutorials.rest,1.2,1.3

[Roman <rom...@us...>]

Update of /cvsroot/pygccxml/source/pyplusplus/docs/tutorials
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6005/pyplusplus/docs/tutorials

Modified Files:
	module_builder.rest tutorials.rest 
Log Message:
I was ill and did not have my TortoiseCVS :-). 
This commit contains documentation changes only. 
Those changes had been done for latest release version.

Index: module_builder.rest
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/docs/tutorials/module_builder.rest,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** module_builder.rest	12 Apr 2006 07:40:34 -0000	1.3
--- module_builder.rest	20 Apr 2006 04:06:42 -0000	1.4
***************
*** 15,20 ****
  --------
  
! I guess you decided to try to use `pyplusplus`_ API. Good! So lets start.
! First of all please take a look on two files:
  
  * `hello_world.hpp`_ - C++ source code, that we want to export to Python
--- 15,20 ----
  --------
  
! I guess you decided to try `pyplusplus`_ API. Good! Lets start. First of all,
! please take a look on two files:
  
  * `hello_world.hpp`_ - C++ source code, that we want to export to Python
***************
*** 30,35 ****
  ----------------
  
! `pyplusplus`_ is built from a few packages, but there is only one package you
! should realy to be familiar with - ``module_builder``. This module is some kind 
  of facade to low level API. It provides simple and intuitive API. The main 
  class within this package is ``module_builder_t``. The instance of this class will 
--- 30,35 ----
  ----------------
  
! `pyplusplus`_ is built from a few packages, but there is only one package, you
! should really to be familiar with - ``module_builder``. This package is some kind 
  of facade to low level API. It provides simple and intuitive API. The main 
  class within this package is ``module_builder_t``. The instance of this class will 
***************
*** 60,64 ****
  Parsing of source files is done within this method. Post condition of this 
  method is - all declarations has been successfully extracted from the sources
! files using the settings you provided.
  
  --------------------------
--- 60,64 ----
  Parsing of source files is done within this method. Post condition of this 
  method is - all declarations has been successfully extracted from the sources
! files.
  
  --------------------------
***************
*** 67,72 ****
  Not all declarations should be exported! Not every declaration could be exported
  without human invocation! As you already saw from example, `pyplusplus`_ provides
! simple and powerful declarations query interface. By default only declarations,
! that belongs to files you have asked to parse and to files, that lies in the same 
  directories as parsed files, will be exported:
  ::
--- 67,72 ----
  Not all declarations should be exported! Not every declaration could be exported
  without human invocation! As you already saw from example, `pyplusplus`_ provides
! simple and powerful declarations query interface. By default, only declarations
! that belongs to files, you have asked to parse, and to files, that lies in the same 
  directories as parsed files, will be exported:
  ::
***************
*** 83,92 ****
    
  All declarations that belongs to ``include`` directory will be signed as included
! to exposing. All other declarations will be ignored.
  
! You can change this final set of exported declarations by calling ``exclude`` or
! ``include`` methods on declarations.
  
! Basically this is a second step of code generation process. During this step
  you could/should/may change `pyplusplus`_ defaults:
  
--- 83,92 ----
    
  All declarations that belongs to ``include`` directory will be signed as included
! to exporting. All other declarations will be ignored.
  
! You can change the set of exported declarations by calling ``exclude`` or
! ``include`` methods, on declarations.
  
! Basically, this is a second step of code generation process. During this step
  you could/should/may change `pyplusplus`_ defaults:
  
***************
*** 97,105 ****
  
  I think it is critical for beginers to see what is going on, right? 
! ``module_builder_t`` class has ``print_declarations``_ method. You can print whole
  declarations tree or some specific declaration. Very convinient, very useful.
  
  -----------------------------------
! module_builder_t build_code_creator
  -----------------------------------
  
--- 97,105 ----
  
  I think it is critical for beginers to see what is going on, right? 
! ``module_builder_t`` class has ``print_declarations`` method. You can print whole
  declarations tree or some specific declaration. Very convinient, very useful.
  
  -----------------------------------
! module_builder_t.build_code_creator
  -----------------------------------
  

Index: tutorials.rest
===================================================================
RCS file: /cvsroot/pygccxml/source/pyplusplus/docs/tutorials/tutorials.rest,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** tutorials.rest	12 Apr 2006 07:40:34 -0000	1.2
--- tutorials.rest	20 Apr 2006 04:06:42 -0000	1.3
***************
*** 16,29 ****
  
  `pyplusplus`_ includes a `graphical interface`_. `Graphical interface`_ 
! is invoked with the ``pyplusplus_gui`` command, or with ``pyplusplus_gui.pyw`` in 
! the scripts subdirectory of the `Python`_ installation directory.
  
! My advise to you is to start with `graphical interface`_, because:
! * you don't have to learn new API
! * few clicks with mouse and you have `boost.python`_ code for your file(s)
! * it is very easy to evaluate `pyplusplus`_ using it
! * you can check whether `GCC-XML`_ is able to compile your code or not
! * you can use it as a guide to `boost.python`_ library
! * you can use it as a wizard to `pyplusplus`_ package
  
  .. _`graphical interface` : ./pyplusplus_demo.png
--- 16,29 ----
  
  `pyplusplus`_ includes a `graphical interface`_. `Graphical interface`_ 
! is invoked with the ``pyplusplus_gui`` command, or with ``pyplusplus_gui.pyw``
! from the ``scripts`` subdirectory of the `Python`_ installation directory.
  
! My advise to you - start with `graphical interface`_, because:
!   * you don't have to learn new API
!   * few clicks with mouse and you have `boost.python`_ code for your file(s)
!   * it is very easy to evaluate `pyplusplus`_ using it
!   * you can check whether `GCC-XML`_ is able to compile your code or not
!   * you can use it as a guide to `boost.python`_ library
!   * it is able to generate `pyplusplus`_ code for you
  
  .. _`graphical interface` : ./pyplusplus_demo.png
***************
*** 45,51 ****
  To be written. I think I should cover here the usage of code creators and code
  creator's tree. Meanwhile you can take a look on the content of 
! ``examples/custom_code_creator`` directory. It contains example how to create 
! your own code creator. To be more specific it exposes ``get*`` and ``set*`` 
! methods as a property.
  
  .. _`pyplusplus` : ./../pyplusplus.html
--- 45,51 ----
  To be written. I think I should cover here the usage of code creators and code
  creator's tree. Meanwhile you can take a look on the content of 
! ``examples/custom_code_creator`` directory. It contains example, that shows how 
! to create your own code creator. To be more specific, it exposes ``get*`` and 
! ``set*`` methods as a single property.
  
  .. _`pyplusplus` : ./../pyplusplus.html