|
From: <rom...@us...> - 2006-08-21 18:35:20
|
Revision: 430 Author: roman_yakovenko Date: 2006-08-21 11:35:11 -0700 (Mon, 21 Aug 2006) ViewCVS: http://svn.sourceforge.net/pygccxml/?rev=430&view=rev Log Message: ----------- updating documentation Modified Paths: -------------- pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py pyplusplus_dev/pyplusplus/decl_wrappers/class_wrapper.py pyplusplus_dev/pyplusplus/decl_wrappers/decl_wrapper_printer.py Modified: pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py =================================================================== --- pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py 2006-08-21 13:42:15 UTC (rev 429) +++ pyplusplus_dev/pyplusplus/decl_wrappers/call_policies.py 2006-08-21 18:35:11 UTC (rev 430) @@ -57,6 +57,7 @@ return default_t() class compound_policy_t( call_policy_t ): + """base class for all call policies, except default one""" def __init__( self, base=None ): call_policy_t.__init__( self ) self._base = base @@ -67,7 +68,8 @@ return self._base def _set_base_policy( self, new_policy ): self._base = new_policy - base_policy = property( _get_base_policy, _set_base_policy ) + base_policy = property( _get_base_policy, _set_base_policy + , doc="base call policy, by default is reference to L{default_t} call policy") def _get_args(self, function_creator): return [] @@ -88,6 +90,7 @@ return declarations.templates.join( name, args ) class return_argument_t( compound_policy_t ): + """implementation for ::boost::python::return_argument call policies""" def __init__( self, position=1, base=None): compound_policy_t.__init__( self, base ) self._position = position Modified: pyplusplus_dev/pyplusplus/decl_wrappers/class_wrapper.py =================================================================== --- pyplusplus_dev/pyplusplus/decl_wrappers/class_wrapper.py 2006-08-21 13:42:15 UTC (rev 429) +++ pyplusplus_dev/pyplusplus/decl_wrappers/class_wrapper.py 2006-08-21 18:35:11 UTC (rev 430) @@ -18,15 +18,15 @@ """boolean, configures how Py++ should generate code for class. Py can generate code using IDL like syntax: - C{class_< ... >( ... )} - C{.def( ... );} + class_< ... >( ... ) + .def( ... ); Or it can generate code using more complex form: - C{typedef bp::class_< my_class > my_class_exposer_t;} - C{my_class_exposer_t my_class_exposer = my_class_exposer_t( "my_class" );} - C{boost::python::scope my_class_scope( my_class_exposer );} - C{my_class_exposer.def( ... );} + typedef bp::class_< my_class > my_class_exposer_t; + my_class_exposer_t my_class_exposer = my_class_exposer_t( "my_class" ); + boost::python::scope my_class_scope( my_class_exposer ); + my_class_exposer.def( ... ); Also, the second way is much longer, it solves few problems: @@ -72,7 +72,7 @@ break return self._indexing_suite indexing_suite = property( _get_indexing_suite - , doc="returns reference to indexing suite configuration class. " \ + , doc="reference to indexing suite configuration class. " \ +"If the class is not STD container, returns None") def _get_always_expose_using_scope( self ): @@ -84,18 +84,20 @@ def _set_always_expose_using_scope( self, value ): self._always_expose_using_scope = value always_expose_using_scope = property( _get_always_expose_using_scope, _set_always_expose_using_scope - , doc="please see L{always_expose_using_scope_documentation} for documentation." ) + , doc="please see L{class_wrapper.always_expose_using_scope_documentation} variable for documentation." ) def _get_equality_comparable( self ): if None is self._equality_comparable: self._equality_comparable = declarations.has_public_equal( self ) return self._equality_comparable - + def _set_equality_comparable( self, value ): self._equality_comparable = value + + equality_comparable = property( _get_equality_comparable, _set_equality_comparable + , doc="indicates existence of public operator=" \ + +"Default value is calculated, based on information presented in the declarations tree" ) - equality_comparable = property( _get_equality_comparable, _set_equality_comparable ) - def _get_less_than_comparable( self ): if None is self._less_than_comparable: self._less_than_comparable = declarations.has_public_less( self ) @@ -104,9 +106,10 @@ def _set_less_than_comparable( self, value ): self._less_than_comparable = value - less_than_comparable = property( _get_less_than_comparable, _set_less_than_comparable ) + less_than_comparable = property( _get_less_than_comparable, _set_less_than_comparable + , doc="indicates existence of public operator<. " \ + +"Default value is calculated, based on information presented in the declarations tree" ) - #this will only be exported if indexing suite is not None and only when needed class class_declaration_t( class_common_details_t , decl_wrapper.decl_wrapper_t @@ -138,13 +141,16 @@ return self._redefine_operators def _set_redefine_operators( self, new_value ): self._redefine_operators = new_value - redefine_operators = property( _get_redefine_operators, _set_redefine_operators ) + redefine_operators = property( _get_redefine_operators, _set_redefine_operators + , doc="tells Py++ to redefine operators from base class in this class, False by default") def _get_held_type(self): return self._held_type def _set_held_type(self, held_type): self._held_type = held_type - held_type = property( _get_held_type, _set_held_type ) + held_type = property( _get_held_type, _set_held_type + , doc="string, this property tells Py++ what HeldType this class has" \ + +"Default value is calculated, based on information presented in exposed declarations" ) def _get_noncopyable(self): if self._noncopyable is None: @@ -152,24 +158,17 @@ return self._noncopyable def _set_noncopyable(self, noncopyable): self._noncopyable= noncopyable - noncopyable = property( _get_noncopyable, _set_noncopyable) + noncopyable = property( _get_noncopyable, _set_noncopyable + , doc="True if the class is noncopyable, False otherwies" \ + +"Default value is calculated, based on information presented in the declarations tree" ) def _get_wrapper_alias( self ): return self._wrapper_alias def _set_wrapper_alias( self, walias ): self._wrapper_alias = walias - wrapper_alias = property( _get_wrapper_alias, _set_wrapper_alias ) + wrapper_alias = property( _get_wrapper_alias, _set_wrapper_alias + , doc="class-wrapper name") - def has_wrapper( self ): - for decl in self.declarations: - if decl.has_wrapper(): - return True - return False - - def _finalize_impl( self, error_behavior ): - for decl in self.declarations: - decl.finalize( error_behavior ) - @property def declaration_code( self ): """ @@ -198,26 +197,32 @@ return self._null_constructor_body def _set_null_constructor_body(self, body): self._null_constructor_body = body - null_constructor_body = property( _get_null_constructor_body, _set_null_constructor_body ) + null_constructor_body = property( _get_null_constructor_body, _set_null_constructor_body + , doc="null constructor code, that will be added as is to the null constructor of class-wrapper") def _get_copy_constructor_body(self): return self._copy_constructor_body def _set_copy_constructor_body(self, body): self._copy_constructor_body = body - copy_constructor_body = property( _get_copy_constructor_body, _set_copy_constructor_body ) + copy_constructor_body = property( _get_copy_constructor_body, _set_copy_constructor_body + , doc="copy constructor code, that will be added as is to the copy constructor of class-wrapper") def add_declaration_code( self, code ): + """adds the code to the declaration section""" self.declaration_code.append( user_text.user_text_t( code ) ) def add_registration_code( self, code, works_on_instance=True ): - """works_on_instance: If true, the custom code can be applied directly to obj inst. - Ex: ObjInst."CustomCode" + """adds the code to the class registration section + + works_on_instance: If true, the custom code can be applied directly to obj inst. + Example: ObjInst."CustomCode" """ self.registration_code.append( user_text.class_user_text_t( code, works_on_instance ) ) #preserving backward computability add_code = add_registration_code def add_wrapper_code( self, code ): + """adds code to the class wrapper class definition""" self.wrapper_code.append( user_text.user_text_t( code ) ) def set_constructors_body( self, body ): Modified: pyplusplus_dev/pyplusplus/decl_wrappers/decl_wrapper_printer.py =================================================================== --- pyplusplus_dev/pyplusplus/decl_wrappers/decl_wrapper_printer.py 2006-08-21 13:42:15 UTC (rev 429) +++ pyplusplus_dev/pyplusplus/decl_wrappers/decl_wrapper_printer.py 2006-08-21 18:35:11 UTC (rev 430) @@ -11,7 +11,7 @@ from pygccxml import declarations class decl_wrapper_printer_t( declarations.decl_printer_t ): - """ Helper class for printing decl tree. """ + """ Helper class for printing declarations tree and Py++ configuration instructions""" JUSTIFY = 20 INDENT_SIZE = 4 This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |
