|
From: <rom...@us...> - 2008-09-14 12:43:32
|
Revision: 1415
http://pygccxml.svn.sourceforge.net/pygccxml/?rev=1415&view=rev
Author: roman_yakovenko
Date: 2008-09-14 12:43:42 +0000 (Sun, 14 Sep 2008)
Log Message:
-----------
improve documentation style
Modified Paths:
--------------
pygccxml_dev/docs/pygccxml.rest
pygccxml_dev/docs/query_interface.rest
pygccxml_dev/docs/upgrade_issues.rest
pyplusplus_dev/docs/documentation/architecture.rest
pyplusplus_dev/docs/documentation/ctypes/this_and_sizeof.rest
pyplusplus_dev/docs/documentation/functions/call_policies.rest
pyplusplus_dev/docs/documentation/how_to/best_practices.rest
pyplusplus_dev/docs/documentation/how_to/templates.rest
pyplusplus_dev/docs/documentation/inserting_code.rest
pyplusplus_dev/docs/documentation/multi_module_development.rest
pyplusplus_dev/docs/documentation/split_module.rest
pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest
Modified: pygccxml_dev/docs/pygccxml.rest
===================================================================
--- pygccxml_dev/docs/pygccxml.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pygccxml_dev/docs/pygccxml.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -56,7 +56,7 @@
#global_ns is the reference to declarations, which describes global( :: ) namespace
global_ns.free_functions( "do_smth", return_type='void', arg_types=[None,'int'] )
-``None`` means "any type". In my opinion the code is prety clear and readable.
+``None`` means "any type". In my opinion, the code is prety clear and readable.
If you want to know more about provided API read `query interface`__ document or
API documentation.
Modified: pygccxml_dev/docs/query_interface.rest
===================================================================
--- pygccxml_dev/docs/query_interface.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pygccxml_dev/docs/query_interface.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -25,8 +25,8 @@
global_ns.member_functions( function=query, arg_types=[None, 'int &'] )
The example is complex, but still readable. In many cases you will find
-yourself looking for one or many declarations using one or two properties of that
-declaration(s). For example:
+yourself, looking for one or many declarations, using one or two declaration properties.
+For example:
.. code-block:: Python
Modified: pygccxml_dev/docs/upgrade_issues.rest
===================================================================
--- pygccxml_dev/docs/upgrade_issues.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pygccxml_dev/docs/upgrade_issues.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -199,7 +199,7 @@
#f is "calldef_t" instance
for arg in f.arguments:
- arg.default_value = <new default value or None>
+ arg.default_value = <<<new default value or None>>>
-------------
Modified: pyplusplus_dev/docs/documentation/architecture.rest
===================================================================
--- pyplusplus_dev/docs/documentation/architecture.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/architecture.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -88,14 +88,10 @@
.. code-block:: Python
mb = module_builder_t( ... )
-
-.. code-block:: Python
-
+
details = mb.namespace( 'details' )
details.exclude()
-
-.. code-block:: Python
-
+
my_class = mb.class_( 'my_class' )
my_class.rename("MyClass")
Modified: pyplusplus_dev/docs/documentation/ctypes/this_and_sizeof.rest
===================================================================
--- pyplusplus_dev/docs/documentation/ctypes/this_and_sizeof.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/ctypes/this_and_sizeof.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -18,7 +18,7 @@
.. code-block:: Python
mb = module_builder_t( ... )
- cls = mb.class_( <your class> )
+ cls = mb.class_( <<<your class>>> )
cls.expose_this = True
cls.expose_sizeof = True
@@ -28,7 +28,7 @@
.. code-block:: Python
import ctypes
- from <your module> import <your class> as data_t
+ from <<<your module>>> import <<<your class>>> as data_t
d = data_t()
print d.this
Modified: pyplusplus_dev/docs/documentation/functions/call_policies.rest
===================================================================
--- pyplusplus_dev/docs/documentation/functions/call_policies.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/functions/call_policies.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -200,14 +200,14 @@
mb = module_builder.module_builder_t( ... )
mb.free_function( ... ).call_policies \
- = call_policies.custom_call_policies( your call policies code )
+ = call_policies.custom_call_policies( <<<your call policies code>>> )
Optionally you can specify name of the header file, which should be included:
.. code-block:: Python
mb.free_function( ... ).call_policies \
- = call_policies.custom_call_policies( your call policies code, "xyz.hpp" )
+ = call_policies.custom_call_policies( <<<your call policies code>>>, "xyz.hpp" )
return_addressof
----------------
Modified: pyplusplus_dev/docs/documentation/how_to/best_practices.rest
===================================================================
--- pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/how_to/best_practices.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -44,7 +44,7 @@
.. code-block:: Python
from module_builder import *
- mb = module_builder_t( ..., cache=file_cache_t( path to project cache file ), ... )
+ mb = module_builder_t( ..., cache=file_cache_t( <<<path to project cache file>>> ), ... )
* Single header file, will also improve performance compiling the generated bindings.
Modified: pyplusplus_dev/docs/documentation/how_to/templates.rest
===================================================================
--- pyplusplus_dev/docs/documentation/how_to/templates.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/how_to/templates.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -73,7 +73,7 @@
code = generate_instantiations_string( ... )
- mb = module_builder_t( [ create_text_fc( code ), other header files ], ... )
+ mb = module_builder_t( [ create_text_fc( code ), <<<other file names>>> ], ... )
...
Function ``create_text_fc`` allows you to extract declarations from the string,
Modified: pyplusplus_dev/docs/documentation/inserting_code.rest
===================================================================
--- pyplusplus_dev/docs/documentation/inserting_code.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/inserting_code.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -182,16 +182,23 @@
def inject_code( cls ):
constructors = cls.constructors()
constructors.body = class instance registration code
- cls.null_constructor_body = class instance registration code
- cls.copy_constructor_body = class instance registration code
+ #if you need to add code to default or copy constructor only
+ #than you can you the following shortcuts
+ cls.null_constructor_body = <<<your code>>>
+ cls.copy_constructor_body = <<<your code>>>
+ #which will update the appropriate ``body`` property.
+
+ #If you want to add code to the class destructor,
+ #use ``add_destructor_code`` method
+ cls.add_destructor_code( <<<your code>>> )
+
+ #If you need to add new class variables:
+ cls.add_wrapper_code( <<<variable declaration>>> )
- cls.add_wrapper_code( destructor declaration and definition code )
- cls.add_wrapper_code( the new class variable definition code )
-
.. code-block:: Python
mb = module_builder_t( ... )
- for cls in mb.classes( relevant classes only ):
+ for cls in mb.classes( <<<relevant classes only>>> ):
inject_code( cls )
------------
Modified: pyplusplus_dev/docs/documentation/multi_module_development.rest
===================================================================
--- pyplusplus_dev/docs/documentation/multi_module_development.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/multi_module_development.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -146,7 +146,7 @@
.. code-block:: Python
mb = module_builder_t( ... )
- mb.register_module_dependency( other module generated code directory )
+ mb.register_module_dependency( <<<other module generated code directory>>> )
------
Modified: pyplusplus_dev/docs/documentation/split_module.rest
===================================================================
--- pyplusplus_dev/docs/documentation/split_module.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/split_module.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -40,7 +40,7 @@
mb = module_builder.module_builder_t(...)
mb.build_code_creator( ... )
- mb.write_module( file name )
+ mb.write_module( <<<file name>>> )
--------------
Multiple files
@@ -92,7 +92,7 @@
mb = module_builder.module_builder_t(...)
mb.build_code_creator( ... )
- mb.split_module( directory name )
+ mb.split_module( <<<directory name>>> )
-------------------------------------------------------------
@@ -133,7 +133,7 @@
mb = module_builder.module_builder_t(...)
mb.build_code_creator( ... )
- mb.split_module( directory name, [ list of huge classes names ] )
+ mb.split_module( <<<directory name>>>, [ <<<list of huge classes names>>> ] )
---------------------------
Fixed set of multiple files
@@ -154,7 +154,7 @@
mb = module_builder.module_builder_t(...)
mb.build_code_creator( ... )
- mb.balanced_split_module( directory name, number of generated source files )
+ mb.balanced_split_module( <<<directory name>>>, <<<number of generated source files>>> )
------------------
Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest
===================================================================
--- pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2008-09-11 19:03:08 UTC (rev 1414)
+++ pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2008-09-14 12:43:42 UTC (rev 1415)
@@ -126,7 +126,7 @@
.. code-block:: Python
- mb.code_creator.license = your license text
+ mb.code_creator.license = <<<your license text>>>
After you call this function, I recommend you not to change declarations
configuration. In most cases the change will take effect, in some cases it will
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
