From 1cd5adbb53161e3fbe7e016ffb580c81b5ec8205 Mon Sep 17 00:00:00 2001 From: Lauro Neto Date: Tue, 23 Mar 2010 16:48:43 -0300 Subject: Small fixes in documentation Reviewer: Hugo Lima Reviewer: Marcelo Lira --- doc/_templates/index.html | 2 +- doc/commandlineoptions.rst | 18 +++++++++++++++++- doc/compiling.rst | 5 +++-- doc/faq.rst | 5 +++++ doc/ownership.rst | 12 +++++++++++- 5 files changed, 37 insertions(+), 5 deletions(-) (limited to 'doc') diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 8ee5ef20d..09486d7ee 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -4,7 +4,7 @@

{{ project }} {{ version }}

-

{{ project }} is a plugin for Generator Runner, thsi generator generates CPython code instead of boost::python code as BoostPythonGenerator does.

+

{{ project }} is a plugin for Generator Runner, this generator generates CPython code instead of boost::python code as BoostPythonGenerator does.

Documentation

diff --git a/doc/commandlineoptions.rst b/doc/commandlineoptions.rst index eede06b31..2dacfc131 100644 --- a/doc/commandlineoptions.rst +++ b/doc/commandlineoptions.rst @@ -12,10 +12,26 @@ Usage Options ------- -.. _option-heuristic: +``--disable-verbose-error-messages`` + Disable verbose error messages. Turn the CPython code hard to debug but saves a few kilobytes + in the generated binding. + +.. _parent-heuristic: ``--enable-parent-ctor-heuristic`` This flag enable an useful heuristic which can save a lot of work related to object ownership when writing the typesystem. For more info, check :ref:`ownership-parent-heuristics`. +.. _pyside-extensions: + +``--enable-pyside-extensions`` + Enable pyside extensions like support for signal/slots. Use this if you are creating a binding based + on PySide. + +.. _return-heuristic: + +``--enable-return-value-heuristic`` + Enable heuristics to detect parent relationship on return values. + For more info, check :ref:`return-value-heuristics`. + diff --git a/doc/compiling.rst b/doc/compiling.rst index c45d7f1a0..d9ce2be4d 100644 --- a/doc/compiling.rst +++ b/doc/compiling.rst @@ -10,8 +10,9 @@ Build requirements ^^^^^^^^^^^^^^^^^^ + CMake >= 2.6.0 -+ Qt4.5 libraries and development headers >= 4.5.0 -+ api-extractor + development headers ++ Python 2.5 (2.6 recommended) ++ Qt4 libraries and development headers >= 4.5 (4.6 recommended) ++ api-extractor + generator runner >= 0.4 Building and installing ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/faq.rst b/doc/faq.rst index 469e9651b..e854f4360 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -11,6 +11,8 @@ General What is Shiboken? ----------------- +Shiboken is a GeneratorRunner plugin that outputs C++ code for CPython extensions. + Here the name generator refers actually to a program composed of a set of *generator classes* that output different resources based on information contained inside C++ header files. @@ -21,6 +23,9 @@ Creating bindings Can I wrap non-Qt libraries? ---------------------------- +Yes. Check Shiboken source code for an example (libsample). + + Is there any runtime dependency on the generated binding? --------------------------------------------------------- diff --git a/doc/ownership.rst b/doc/ownership.rst index 64fa77a5b..69791f855 100644 --- a/doc/ownership.rst +++ b/doc/ownership.rst @@ -108,9 +108,19 @@ Parentship heuristics type system when binding Qt libraries. For Qt, this heuristic works in all cases, but be aware that it might not when binding your own libraries. - To activate this heuristic, use the :ref:`--enable-parent-ctor-heuristic ` + To activate this heuristic, use the :ref:`--enable-parent-ctor-heuristic ` command line switch. +.. _return-value-heuristics: + +Return value heuristics +----------------------- + + When enabled, object returned as pointer in C++ will become child of the object on which the method + was called. + + To activate this heuristic, use the :ref:`--enable-return-value-heuristic ` + Common pitfalls =============== -- cgit v1.2.3