|
From: Roman <rom...@us...> - 2006-04-20 04:06:48
|
Update of /cvsroot/pygccxml/source/pyplusplus/module_builder In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv6005/pyplusplus/module_builder Modified Files: __init__.py builder.py 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: builder.py =================================================================== RCS file: /cvsroot/pygccxml/source/pyplusplus/module_builder/builder.py,v retrieving revision 1.8 retrieving revision 1.9 diff -C2 -d -r1.8 -r1.9 *** builder.py 6 Apr 2006 06:16:08 -0000 1.8 --- builder.py 20 Apr 2006 04:06:44 -0000 1.9 *************** *** 16,19 **** --- 16,25 ---- class module_builder_t(object): + """ + This class provides users with simple and intuitive interface to pyplusplus + and/or pygccxml functionality. If this is your first attempt to use pyplusplus + consider to read tutorials. You can find them on U{web site<http://www.language-binding.net>}. + """ + def __init__( self , files *************** *** 28,31 **** --- 34,55 ---- , cache=None , optimize_queries=True): + """ + @param files: list of files, declarations from them you want to export + @type files: list of strings or L{file_configuration_t} instances + + @param gccxml_path: path to gccxml binary. If you don't pass this argument, + pygccxml parser will try to locate it using you environment PATH variable + @type gccxml_path: str + + @param include_paths: additional header files location. You don't have to + specify system and standard directories. + @type include_paths: list of strings + + @param define_symbols: list of symbols to be defined for preprocessor. + @param define_symbols: list of strings + + @param undefine_symbols: list of symbols to be undefined for preprocessor. + @param undefine_symbols: list of strings + """ object.__init__( self ) gccxml_config = parser.config_t( *************** *** 60,63 **** --- 84,92 ---- def run_query_optimizer(self): + """ + It is possible to optimze time that takes to execute queries. In most cases + this is done from __init__ method. But there are use-case, when you need + to disable optimizer at __init__ and run it later. + """ self.__global_ns.init_optimizer() *************** *** 108,111 **** --- 137,147 ---- def print_declarations(self, decl=None): + """ + This function will print detailed description of all declarations or + some specific one. + + @param decl: optional, if passed, then only it will be printed + @type decl: instance of L{decl_wrappers.decl_wrapper_t} class + """ if None is decl: decl = self.global_ns *************** *** 119,122 **** --- 155,172 ---- , types_db=None , target_configuration=None ): + """ + Creates L{module_t} code creator. + + @param module_name: module name + @type module_name: string + + @param boost_python_ns_name: boost::python namespace alias, by default + it is 'bp' + @type boost_python_ns_name: string + + @param call_policies_resolver_: callable, that will be invoked on every + calldef object. It should return call policies. + @type call_policies_resolver_: callable + """ creator = mcreator_package.creator_t( self.global_ns , module_name *************** *** 141,156 **** def has_code_creator( self ): return not ( None is self.__code_creator ) def write_module( self, file_name ): ! """ Writes module to single file""" file_writers.write_file( self.code_creator, file_name ) def split_module(self, dir_name): ! """Writes module to multiple files""" file_writers.write_multiple_files( self.code_creator, dir_name ) #select decl(s) interfaces def decl( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): return self.global_ns.decl( name=name , function=function --- 191,220 ---- def has_code_creator( self ): + """ + Function, that will return True if build_code_creator function has been + called and False otherwise + """ return not ( None is self.__code_creator ) def write_module( self, file_name ): ! """ ! Writes module to single file ! @param file_name: file name ! @type file_name: string ! """ file_writers.write_file( self.code_creator, file_name ) def split_module(self, dir_name): ! """ ! Writes module to multiple files ! ! @param dir_name: directory name ! @type dir_name: string ! """ file_writers.write_multiple_files( self.code_creator, dir_name ) #select decl(s) interfaces def decl( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.decl( name=name , function=function *************** *** 160,163 **** --- 224,228 ---- def decls( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.decls( name=name , function=function *************** *** 167,170 **** --- 232,236 ---- def class_( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.class_( name=name , function=function *************** *** 174,177 **** --- 240,244 ---- def classes( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.classes( name=name , function=function *************** *** 181,184 **** --- 248,252 ---- def variable( self, name=None, function=None, type=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.variable( name=name , function=function *************** *** 189,192 **** --- 257,261 ---- def variables( self, name=None, function=None, type=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.variables( name=name , function=function *************** *** 197,200 **** --- 266,270 ---- def calldef( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.calldef( name=name , function=function *************** *** 206,209 **** --- 276,280 ---- def calldefs( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.calldefs( name=name , function=function *************** *** 215,218 **** --- 286,290 ---- def operator( self, name=None, symbol=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.operator( name=name , symbol=symbol *************** *** 226,229 **** --- 298,302 ---- def operators( self, name=None, symbol=None, return_type=None, arg_types=None, decl_type=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.operators( name=name , symbol=symbol *************** *** 237,240 **** --- 310,314 ---- def member_function( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.member_function( name=name , function=function *************** *** 246,249 **** --- 320,324 ---- def member_functions( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.member_functions( name=name , function=function *************** *** 255,258 **** --- 330,334 ---- def constructor( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.constructor( name=name , function=function *************** *** 264,267 **** --- 340,344 ---- def constructors( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.constructors( name=name , function=function *************** *** 273,276 **** --- 350,354 ---- def member_operator( self, name=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.member_operator( name=name , symbol=symbol *************** *** 283,286 **** --- 361,365 ---- def member_operators( self, name=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.member_operators( name=name , symbol=symbol *************** *** 293,296 **** --- 372,376 ---- def casting_operator( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.casting_operator( name=name , function=function *************** *** 302,305 **** --- 382,386 ---- def casting_operators( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.casting_operators( name=name , function=function *************** *** 311,314 **** --- 392,396 ---- def enumeration( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.enumeration( name=name , function=function *************** *** 319,322 **** --- 401,405 ---- def enumerations( self, name=None, function=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.scopedef_t} class documentation""" return self.global_ns.enumerations( name=name , function=function *************** *** 328,331 **** --- 411,415 ---- def namespace( self, name=None, function=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.namespace( name=name , function=function *************** *** 333,336 **** --- 417,421 ---- def namespaces( self, name=None, function=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.namespaces( name=name , function=function *************** *** 338,341 **** --- 423,427 ---- def free_function( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.free_function( name=name , function=function *************** *** 347,350 **** --- 433,437 ---- def free_functions( self, name=None, function=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.free_functions( name=name , function=function *************** *** 356,359 **** --- 443,447 ---- def free_operator( self, name=None, function=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.free_operator( name=name , symbol=symbol *************** *** 366,369 **** --- 454,458 ---- def free_operators( self, name=None, function=None, symbol=None, return_type=None, arg_types=None, header_dir=None, header_file=None, recursive=None ): + """Please see L{decl_wrappers.namespace_t} class documentation""" return self.global_ns.free_operators( name=name , symbol=symbol Index: __init__.py =================================================================== RCS file: /cvsroot/pygccxml/source/pyplusplus/module_builder/__init__.py,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** __init__.py 29 Mar 2006 04:26:58 -0000 1.2 --- __init__.py 20 Apr 2006 04:06:44 -0000 1.3 *************** *** 4,7 **** --- 4,16 ---- # http://www.boost.org/LICENSE_1_0.txt) + """ + This package provides users with simple and convinient interface to pyplusplus + functionality. + + L{module_builder_t} class is the main class. Please read it's documentation first. + Also take a look on tutorials. You can find them on pyplusplus + U{web site<http://www.language-binding.net>} + """ + from builder import module_builder_t |
