diff options
Diffstat (limited to 'doc/faq.rst')
| -rw-r--r-- | doc/faq.rst | 55 |
1 files changed, 2 insertions, 53 deletions
diff --git a/doc/faq.rst b/doc/faq.rst index 38cc3f186..469e9651b 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -8,52 +8,19 @@ suggest new entries! General ======= -What is the generator? ----------------------- +What is Shiboken? +----------------- 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. -What is the API Extractor? --------------------------- - -It is a library that parses C++ header files and builds a data model around -them in order to ease the work of manipulating these data inside -*generators*. - - -Is there any similar tools around? ----------------------------------- - -The generator framework actually started as a fork of the qtscriptgenerator, -with the focus on python bindings instead of QtScript. After some time, the -python-specific code was split from the the header parsing and data model -code. The former became what we call *generator* while the latter is now -called *API Extractor*. - -What's the relationship between the generator and the API Extractor? --------------------------------------------------------------------- - -The generator system relies heavily in the API Extractor classes, using -them as syntatic sugar to access the data model of the classes being -wrapped. - -What are the dependencies to run the generator? ------------------------------------------------ - -API Extractor, QtCore and QtXml. - Creating bindings ================= Can I wrap non-Qt libraries? ---------------------------- -Although it's not yet well tested, there's a good chance that non-Qt -libraries can be wrapped using the generator. But remember that -generator injects runtime dependency on Qt for the generated binding. - Is there any runtime dependency on the generated binding? --------------------------------------------------------- @@ -87,21 +54,3 @@ What is 'inject code'? That's how we call customized code that will be *injected* into the generated at specific locations. They are specified inside the typesytem. -How can I document my project? ------------------------------- - -The generator also can generate the API documentation based on the -C++ headers documentation using the qdoc syntax. Optionally you can -inject documentation at specific parts. Likewise *inject code*, the -customized documentation is specified inside the typesystem. - -Other -===== - -Is there any current limitation within the generator/API Extractor? -------------------------------------------------------------------- - -The generator currently does not automatically detects implicit C++ -type conversions. Also the code snippets in function signature and -examples are still in C++ inside the generated documentation. - |