diff options
author | Hugo Lima <hugo.lima@openbossa.org> | 2009-11-30 18:00:24 -0200 |
---|---|---|
committer | Hugo Lima <hugo.lima@openbossa.org> | 2009-11-30 20:43:18 -0200 |
commit | ea768f172b2114c0a07e07e5ae7903f675bc665d (patch) | |
tree | d118a5c3fd37fdbd36416bc9481d03f861a80639 /doc/commandlineoptions.rst | |
parent | ed4721dd84cb3f637dabb6803c7692c11437f80a (diff) |
Added documentation to shiboken command line options.
Diffstat (limited to 'doc/commandlineoptions.rst')
-rw-r--r-- | doc/commandlineoptions.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/commandlineoptions.rst b/doc/commandlineoptions.rst new file mode 100644 index 000000000..ddd864a48 --- /dev/null +++ b/doc/commandlineoptions.rst @@ -0,0 +1,15 @@ +Command line options +******************** + +At the moment, there is just one flag to change the |project| behaviour, ``--enable-parent-ctor-heuristic``. This flag enable an usefull heuristic which can save a lot of work when writing the typesystem. + +This heuristic will be triggered when generating code for a method and: + +* The function is a constructor. +* The argument name is "parent". +* The argument type is a pointer to an object. + +When triggered, the heuristic will set the argument named "parent" as the parent of the current object. +Being a child of an object means that when the object's parent dies, the C++ instance also dies, so the Python references will be invalidated. + +The main focus of this tag was to remove a lot of hand written code from typesystem when binding Qt libraries, for Qt, this heuristic is never wrong, but be aware that it might be when binding your own libraries. |