[pygccxml-commit] SF.net SVN: pygccxml: [1019] pyplusplus_dev/docs
Brought to you by:
mbaas,
roman_yakovenko
From: <rom...@us...> - 2007-04-25 05:15:36
|
Revision: 1019 http://svn.sourceforge.net/pygccxml/?rev=1019&view=rev Author: roman_yakovenko Date: 2007-04-24 22:15:33 -0700 (Tue, 24 Apr 2007) Log Message: ----------- fixing spelling errors Modified Paths: -------------- pygccxml_dev/docs/design.rest pygccxml_dev/docs/query_interface.rest pyplusplus_dev/docs/comparisons/compare_to.rest pyplusplus_dev/docs/comparisons/pyste.rest pyplusplus_dev/docs/documentation/best_practices.rest pyplusplus_dev/docs/documentation/containers.rest pyplusplus_dev/docs/documentation/functions/registration_order.rest pyplusplus_dev/docs/documentation/functions/transformation/built_in/input_static_array.rest pyplusplus_dev/docs/documentation/functions/transformation/built_in/modify_type.rest pyplusplus_dev/docs/documentation/functions/transformation/built_in/output_static_array.rest pyplusplus_dev/docs/documentation/functions/transformation/built_in/transfer_ownership.rest pyplusplus_dev/docs/documentation/functions/transformation/custom/custom.rest pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest pyplusplus_dev/docs/documentation/how_to.rest pyplusplus_dev/docs/documentation/index.rest pyplusplus_dev/docs/documentation/inserting_code.rest pyplusplus_dev/docs/documentation/multi_module_development.rest pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest pyplusplus_dev/docs/documentation/warnings.rest pyplusplus_dev/docs/history/history.rest pyplusplus_dev/docs/peps/dsl_challenge.rest pyplusplus_dev/docs/peps/peps_index.rest pyplusplus_dev/docs/pyplusplus.rest pyplusplus_dev/docs/quotes.rest pyplusplus_dev/docs/troubleshooting_guide/lessons_learned.rest pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest Modified: pygccxml_dev/docs/design.rest =================================================================== --- pygccxml_dev/docs/design.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pygccxml_dev/docs/design.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -137,7 +137,7 @@ * cache - classes, those one will help you to eliminate unnecessary parsing -* patchers - classes, that fix `GCC-XML`_ generated declarations. ( Yes, sometimes +* patchers - classes, which fix `GCC-XML`_ generated declarations. ( Yes, sometimes GCC-XML generates wrong description of C++ declaration. ) Parser classes @@ -227,9 +227,8 @@ There are few cache classes, which implements different cache strategies. -1. ``file_configuration_t`` class, that keeps pass to C++ source file and path to - `GCC-XML`_ generated XML file. This class is not a cache class, but it also - allows you to save your time. +1. ``file_configuration_t`` class, that keeps path to C++ source file and path to + `GCC-XML`_ generated XML file. 2. ``file_cache_t`` class, will save all declarations from all files within single binary file. @@ -277,7 +276,7 @@ Summary ------- -Thats all. I hope I was clear, at least I tried. Any way, `pygccxml`_ is an open +That's all. I hope I was clear, at least I tried. Any way, `pygccxml`_ is an open source project. You always can take a look on the source code. If you need more information please read API documentation. Modified: pygccxml_dev/docs/query_interface.rest =================================================================== --- pygccxml_dev/docs/query_interface.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pygccxml_dev/docs/query_interface.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -24,8 +24,8 @@ query = query & ~declarations.access_type_matcher_t( 'public' ) global_ns.member_functions( function=query, arg_types=[None, 'int &'] ) -The example is complex, but still readable. In many cases you will find your -self looking for one or many declarations using one or two properties of that +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: .. code-block:: Python @@ -105,8 +105,8 @@ * ``return_type`` - Function return type. This argument can be Python string or an object that - describes C++ type. + the function return type. This argument can be string or an object that describes + C++ type. .. code-block:: Python @@ -129,7 +129,7 @@ mem_funcs = my_class.member_functions( arg_types=[ None, 'int'] ) - ``mem_funcs`` will contain all member functions, that have two arguments + ``mem_funcs`` will contain all member functions, which have two arguments and type of second argument is ``int``. * ``header_dir`` Modified: pyplusplus_dev/docs/comparisons/compare_to.rest =================================================================== --- pyplusplus_dev/docs/comparisons/compare_to.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/comparisons/compare_to.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -49,7 +49,7 @@ .. _`PyOgre` : http://www.ogre3d.org/wiki/index.php/PyOgre -Some other links, that compare Boost.Python, SWIG, SIP and other tools: +Some other links, which compares Boost.Python, SWIG, SIP and other tools: * `Evaluation of Python/C++ interfacing packages`_ Modified: pyplusplus_dev/docs/comparisons/pyste.rest =================================================================== --- pyplusplus_dev/docs/comparisons/pyste.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/comparisons/pyste.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -44,7 +44,7 @@ analyzes. If you identify one, please report it. I will try to fix it, as quick as possible. In the past, I created bindings to few projects using `Pyste`_. Code, generated by `Pyste`_, was pretty good and gave me a good start both with -my projects and with `Boost.Python`_ library. As for me, there are 2 main +my projects and with `Boost.Python`_ library. As for me, there are two main problems with `Pyste`_: 1. It is time-consuming operation to maintain `Pyste`_ scripts in a big, @@ -116,7 +116,7 @@ code. 2. Module creator package. This is code creators factory. Classes in this - package analyze C++ declarations and creates relevant code creators. + package, analyze C++ declarations and creates relevant code creators. 3. File writers package. This package contains classes that write generated code to file(s). @@ -167,7 +167,7 @@ * few parsing strategies: - + all files will be parsed as it was one file that include all them + + all files will be parsed as it was one file that includes all them + every file will be parsed alone, after this, duplicated declarations and types will be removed @@ -375,7 +375,7 @@ 1. It is easier to understand compilation error. - 2. If in future a developer decide to create overload to some function, + 2. If in future a developer decides to create overload to some function, this code will continue to compile. * `Py++`_ has small nice future - "license". User can specify the Modified: pyplusplus_dev/docs/documentation/best_practices.rest =================================================================== --- pyplusplus_dev/docs/documentation/best_practices.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/best_practices.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -38,7 +38,7 @@ couple minutes with a reasonable cache size. You can read more about different caches supported by `pygccxml`_ `here`__. - ``module_builder_t.__init__`` methods takes reference to an instance of cache + ``module_builder_t.__init__`` method takes reference to an instance of cache class or ``None``: .. code-block:: Python Modified: pyplusplus_dev/docs/documentation/containers.rest =================================================================== --- pyplusplus_dev/docs/documentation/containers.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/containers.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -185,7 +185,7 @@ 1. If you set ``equality_comparable`` or ``less_than_comparable`` to ``False``. The indexing suite will disable relevant functionality. You don't have - explicitly to disable method or mothods group. + explicitly to disable method or methods group. 2. The documentation of new indexing suite contains few small mistakes. I hope, I will have time to fix them. Any way, `Py++`_ generates Modified: pyplusplus_dev/docs/documentation/functions/registration_order.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/registration_order.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/registration_order.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -91,7 +91,7 @@ overloaded functions, if it can convert `Python`_ arguments to C++ ones, it does this and calls the function. -Now, when you understand the behaviour, it should be pretty simple to provide +Now, when you understand the behavior, it should be pretty simple to provide a correct functionality: 1. You can change alias of the function, by mangling the type of the argument Modified: pyplusplus_dev/docs/documentation/functions/transformation/built_in/input_static_array.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/built_in/input_static_array.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/built_in/input_static_array.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -14,7 +14,7 @@ "input_static_array" transformer takes as first argument name or index of the original function argument. The argument should have "array" or "pointer" type. -The second argument should an integer value, that represents array size. +The second argument should an integer value, which represents array size. ------- Example Modified: pyplusplus_dev/docs/documentation/functions/transformation/built_in/modify_type.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/built_in/modify_type.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/built_in/modify_type.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -16,7 +16,7 @@ 2. a callable, which takes as argument reference to type and returns new type -New in version grater than 0.8.5. +New in version greater than 0.8.5. Pay attention! -------------- Modified: pyplusplus_dev/docs/documentation/functions/transformation/built_in/output_static_array.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/built_in/output_static_array.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/built_in/output_static_array.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -13,7 +13,7 @@ "output_static_array" transformer takes as first argument name or index of the original function argument. The argument should have "array" or "pointer" type. -The second argument should an integer value, that represents array size. +The second argument should an integer value, which represents array size. ------- Example Modified: pyplusplus_dev/docs/documentation/functions/transformation/built_in/transfer_ownership.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/built_in/transfer_ownership.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/built_in/transfer_ownership.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -18,7 +18,7 @@ "transfer_ownership" transformer takes one argument, name or index of the original function argument. The argument type should be "pointer". -New in version grater than 0.8.5. +New in version greater than 0.8.5. ------- Example Modified: pyplusplus_dev/docs/documentation/functions/transformation/custom/custom.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/custom/custom.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/custom/custom.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -18,8 +18,8 @@ How to ...? ----------- -Unfortunately I don't have enough time to write a complete documentation :-(. -Meanwhile fill free to `contact me`_. You also can take a look on `built-in transformers`_ +Unfortunately I don't have enough time to write a complete documentation :-(, +fill free to `contact me`_. You also can take a look on `built-in transformers`_ implementation. .. _`contact me` : ../../../../links.html#id5 Modified: pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest =================================================================== --- pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/functions/transformation/transformation.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -75,7 +75,7 @@ Thanks to --------- -Thanks goes to Matthias Baas for his efforts and hard work. He did a research, +A thanks goes to Matthias Baas for his efforts and hard work. He did a research, implemented the initial working version and wrote a lot of documentation. .. _`Py++` : ./../pyplusplus.html Modified: pyplusplus_dev/docs/documentation/how_to.rest =================================================================== --- pyplusplus_dev/docs/documentation/how_to.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/how_to.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -348,7 +348,7 @@ .. _`constraints` : http://www.python.org/doc/current/ref/identifiers.html -There are few pretty good reasons for this behaviour: +There are few pretty good reasons for this behavior: * when you just start to work on `Python`_ bindings concentrate your attention on really important things Modified: pyplusplus_dev/docs/documentation/index.rest =================================================================== --- pyplusplus_dev/docs/documentation/index.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/index.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -14,7 +14,7 @@ How can you help? * Lets face it: today it is not possible to use `Py++`_ without eventually - looking into source code. `Py++`_ uses `Epydoc`_ to generate documentation + looking into source code. `Py++`_ uses `epydoc`_ to generate documentation from source files. So, if you found some undocumented piece of code and you understand what it does, please write documentation string. @@ -48,7 +48,7 @@ .. _`best practices`: ./best_practices.html -* `documentation string`_ - explains how to automaticly extract a documentation +* `documentation string`_ - explains how to automatically extract a documentation from the source files and put it as Python documentation string .. _`documentation string` : ./doc_string.html @@ -56,7 +56,7 @@ * `warnings`_ - `Py++`_ could be used as some kind of validator. It checks the exposed declarations and reports the potential errors. Thus you are able to create high quality Python bindings from the beginning. This document also - describes how to supress the errors\\warnings. + describes how to suppress the errors\\warnings. .. _`warnings` : ./warnings.html @@ -65,7 +65,7 @@ .. _`functions & operators` : ../functions/functions.html -* `hints`_ - describes few techinques, which will help you with exposing template +* `hints`_ - describes few techniques, which will help you with exposing template instantiations .. _`hints`: ./hints.html @@ -94,7 +94,7 @@ .. _`tutorials` : ./tutorials/tutorials.html -.. _`Epydoc` : http://epydoc.sourceforge.net/ +.. _`epydoc` : http://epydoc.sourceforge.net/ .. _`Py++` : ./../pyplusplus.html .. _`Boost.Python`: http://www.boost.org/libs/python/doc/index.html .. _`Python`: http://www.python.org Modified: pyplusplus_dev/docs/documentation/inserting_code.rest =================================================================== --- pyplusplus_dev/docs/documentation/inserting_code.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/inserting_code.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -100,7 +100,7 @@ This method will add the code to the declaration section within the module. If you split your module to few files, `Py++`_ will add this code to the - cpp file, class registration code will be written in. + "cpp" file, class registration code will be written in. Attention: there is no defined order between wrapper code and declaration section code. If you have dependencies between code from declaration section and class Modified: pyplusplus_dev/docs/documentation/multi_module_development.rest =================================================================== --- pyplusplus_dev/docs/documentation/multi_module_development.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/multi_module_development.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -8,7 +8,7 @@ Introduction ------------ -It is a common practises to construct final program or a package from few +It is a common practices to construct final program or a package from few different dependent or independent C++ libraries. Many time these libraries reuse classes\\functions defined in some other library. I think this is a must requirement from a code generator to be able to expose these libraries to `Python`_ , Modified: pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest =================================================================== --- pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/tutorials/module_builder/module_builder.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -114,8 +114,8 @@ Now it is a time to create module code creator. Do you remember, in introduction to `Py++`_, I told you that before writing code to disc, `Py++`_ will create some -kind of `AST`_. Well this is done by calling ``module_builder_t.build_code_creator`` -function. Right now, the only important argument to the function is ``module_name``. +kind of `AST`_. Well calling module_builder_t.build_code_creator function does this. +Right now, the only important argument to the function is ``module_name``. Self explained, is it? Modified: pyplusplus_dev/docs/documentation/warnings.rest =================================================================== --- pyplusplus_dev/docs/documentation/warnings.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/documentation/warnings.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -35,7 +35,7 @@ virtual Y& do_smth(); }; - Member function ``do_smth`` can not be overridden in Python because... [FILL IN HERE]. + Member function ``do_smth`` cannot be overridden in Python because ... . * .. code-block:: C++ @@ -45,7 +45,7 @@ void get_size( int& height, int& width ) const; }; - Member function ``get_size`` can be exposed to Python, but it will not be callable because [FILL IN HERE]. + Member function ``get_size`` can be exposed to Python, but it will not be callable because ... . * In order to expose free/member function that takes more than 10 arguments user should define ``BOOST_PYTHON_MAX_ARITY`` macro. @@ -75,8 +75,8 @@ In previous paragraph, I described some pretty useful functionality but what should you do to enable it? - *Nothing!* By default, `Py++`_ only prints the -important messages to ``stdout``. More over it prints them only for declarations -that are going to be exported. +important messages to ``stdout``. More over, it prints them only for to be exposed +declarations. `Py++`_ uses the python `logging`_ package to write all user messages. By default, messages with ``DEBUG`` level will be skipped, all other messages will Modified: pyplusplus_dev/docs/history/history.rest =================================================================== --- pyplusplus_dev/docs/history/history.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/history/history.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -81,7 +81,7 @@ 6. Added ability to control generated "include" directives. Now you can ask `Py++`_ to include a header file, when it generates code for some declaration. For more - information refer to `inserting code guide`_. + information refers to `inserting code guide`_. .. _`inserting code guide` : ../documentation/inserting_code.html#header-files @@ -95,7 +95,7 @@ .. line-separator -9. Added ability to add code before overriden and default function calls. +9. Added ability to add code before overridden and default function calls. For more information refer to `member function API documentation`_. .. _`member function API documentation` : ../documentation/apidocs/pyplusplus.decl_wrappers.calldef_wrapper.member_function_t-class.html Modified: pyplusplus_dev/docs/peps/dsl_challenge.rest =================================================================== --- pyplusplus_dev/docs/peps/dsl_challenge.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/peps/dsl_challenge.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -117,7 +117,7 @@ PointTmpl = mb.module.template('Point') Point = PointTmpl( 'int' ) - This is a trivial example, that is why it looks grate. Consider next class: + This is a trivial example, which is why it looks grate. Consider next class: .. code-block:: C++ Modified: pyplusplus_dev/docs/peps/peps_index.rest =================================================================== --- pyplusplus_dev/docs/peps/peps_index.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/peps/peps_index.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -60,13 +60,13 @@ In version 0.8.1 `Py++`_ introduced nice feature: automatic extraction and integration of documentation strings. I estimated wrong the influence of the feature on the project. First user, who actually tried it, was Gottfried Ganssauge. -He asked me to add support for documentation string that contains unicode characters. +He asked me to add support for documentation string that contains Unicode characters. These days I understand the influence. I should convert all strings in the whole -project to be unicode strings, with encoding specified by the user. This is a +project to be Unicode strings, with encoding specified by the user. This is a lot of work, but I think this is really important. So this is high priority "TODO". http://www.joelonsoftware.com/articles/Unicode.html - a nice article, which -explains what is unicode, encoding and character sets. +explains what is Unicode, encoding and character sets. .. _`Py++` : ./../pyplusplus.html Modified: pyplusplus_dev/docs/pyplusplus.rest =================================================================== --- pyplusplus_dev/docs/pyplusplus.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/pyplusplus.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -81,7 +81,7 @@ mb.calldefs( access_type_matcher_t( 'protected' ) ).exclude() The developer can create custom criteria, for example exclude all declarations -that have 'impl' ( implementation ) string within the name. +with 'impl' ( implementation ) string within the name. .. code-block:: Python @@ -118,7 +118,7 @@ ----------------------- During this step Py++ reads code creators tree and writes code to the disc. The result of code generation process should not be different from the one, -that would be achieved by human. For small project writing all code into single +which would be achieved by human. For small project writing all code into single file is good approach, for big ones code should be written into multiple files. Py++ implements both strategies. Modified: pyplusplus_dev/docs/quotes.rest =================================================================== --- pyplusplus_dev/docs/quotes.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/quotes.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -36,7 +36,7 @@ Lakin Wecker, the author of `Python-OGRE`_ project "... Py++ allows the wrappers to be "automagically" created, which means it's much -easier to keep things up to date (the maintainence on the Py++ based wrapper is +easier to keep things up to date (the maintenance on the Py++ based wrapper is tiny compared to any other system I've used). It also allows us to wrap other libraries fairly easily. " Modified: pyplusplus_dev/docs/troubleshooting_guide/lessons_learned.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/lessons_learned.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/troubleshooting_guide/lessons_learned.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -8,7 +8,7 @@ Preamble -------- -Software development is an interactrive process. During `Py++`_ development +Software development is an interactive process. During `Py++`_ development I see many interesting problems and even more interesting solutions. On this page you will find my collection of the solutions to some of the problems. Modified: pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest =================================================================== --- pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest 2007-04-25 04:10:48 UTC (rev 1018) +++ pyplusplus_dev/docs/troubleshooting_guide/shared_ptr/shared_ptr.rest 2007-04-25 05:15:33 UTC (rev 1019) @@ -16,7 +16,7 @@ There are two possible solutions to the problem. The first one is to fix Boost.Python library: `pointer_holder.hpp.patch`_ . The patch was contributed -to the library ( 8-December-2006 ) and some day it will be commited to the CVS. +to the library ( 8-December-2006 ) and some day it will be committed to the CVS. It is also possible to solve the problem, without changing Boost.Python library: This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |