summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLauro Neto <lauro.neto@openbossa.org>2010-03-23 16:48:43 -0300
committerLauro Neto <lauro.neto@openbossa.org>2010-03-23 17:08:23 -0300
commit1cd5adbb53161e3fbe7e016ffb580c81b5ec8205 (patch)
tree1b2a40c53ce63e90f299e3c98d842c360848634b /doc
parente253f00a604ffad4398173bea2916ca4d28ae1c4 (diff)
downloadshiboken-1cd5adbb53161e3fbe7e016ffb580c81b5ec8205.tar.gz
shiboken-1cd5adbb53161e3fbe7e016ffb580c81b5ec8205.tar.xz
shiboken-1cd5adbb53161e3fbe7e016ffb580c81b5ec8205.zip
Small fixes in documentation
Reviewer: Hugo Lima <hugo.lima@openbossa.org> Reviewer: Marcelo Lira <marcelo.lira@openbossa.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/_templates/index.html2
-rw-r--r--doc/commandlineoptions.rst18
-rw-r--r--doc/compiling.rst5
-rw-r--r--doc/faq.rst5
-rw-r--r--doc/ownership.rst12
5 files changed, 37 insertions, 5 deletions
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index 8ee5ef20..09486d7e 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -4,7 +4,7 @@
<div class="section">
<h1>{{ project }} {{ version }}</h1>
- <p>{{ project }} is a plugin for Generator Runner, thsi generator generates CPython code instead of boost::python code as BoostPythonGenerator does.</p>
+ <p>{{ project }} is a plugin for Generator Runner, this generator generates CPython code instead of boost::python code as BoostPythonGenerator does.</p>
<h2>Documentation</h2>
<table class="contentstable" align="center" style="margin-left: 30px"><tr>
diff --git a/doc/commandlineoptions.rst b/doc/commandlineoptions.rst
index eede06b3..2dacfc13 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 c45d7f1a..d9ce2be4 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 469e9651..e854f436 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 64fa77a5..69791f85 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 <option-heuristic>`
+ To activate this heuristic, use the :ref:`--enable-parent-ctor-heuristic <parent-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 <return-heuristic>`
+
Common pitfalls
===============