1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
.. _command-line:
Command line options
********************
Usage
-----
::
shiboken [options] header-file typesystem-file
Options
-------
``--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`.
.. _avoid-protected-hack:
``--avoid-protected-hack``
Avoid the use of the '#define protected public' hack.
.. _use-isnull-as-nb_nonzero:
``--use-isnull-as-nb_nonzero``
If a class have an isNull() const method, it will be used to
compute the value of boolean casts
.. _api-version:
``--api-version=<version>``
Specify the supported api version used to generate the bindings.
.. _documentation-only:
``--documentation-only``
Do not generate any code, just the documentation.
.. _drop-type-entries:
``--drop-type-entries="<TypeEntry0>[;TypeEntry1;...]"``
Semicolon separated list of type system entries (classes, namespaces,
global functions and enums) to be dropped from generation.
.. _generation-set:
``--generation-set``
Generator set to be used (e.g. qtdoc).
.. _diff:
``--diff``
Print a diff of wrapper files.
.. _dryrun:
``--dryrun``
Dry run, do not generate wrapper files.
.. _--project-file:
``--project-file=<file>``
Text file containing a description of the binding project.
Replaces and overrides command line arguments.
.. _include-paths:
``-I<path>, --include-paths=<path>[:<path>:...]``
Include paths used by the C++ parser.
... _system-include-paths:
``-isystem<path>, --system-include-paths=<path>[:<path>:...]``
System include paths used by the C++ parser
.. _framework-include-paths:
``-F<path>, --framework-include-paths=<path>[:<path>:...]``
Framework include paths used by the C++ parser
.. _language-level:
``--language-level=, -std=<level>``
C++ Language level (c++11..c++17, default=c++14)
.. _typesystem-paths:
``-T<path>, --typesystem-paths=<path>[:<path>:...]``
Paths used when searching for type system files.
.. _output-directory:
``--output-directory=[dir]``
The directory where the generated files will be written.
.. _license-file=[license-file]:
``--license-file=[license-file]``
File used for copyright headers of generated files.
.. _no-suppress-warnings:
``--no-suppress-warnings``
Show all warnings.
.. _silent:
``--silent``
Avoid printing any message.
.. _debug-level:
``--debug-level=[sparse|medium|full]``
Set the debug level.
.. _help:
``--help``
Display this help and exit.
.. _version:
``--version``
Output version information and exit.
QtDocGenerator Options
----------------------
.. _doc-parser:
``--doc-parser=<parser>``
The documentation parser used to interpret the documentation
input files (qdoc|doxygen).
.. _documentation-code-snippets-dir:
``--documentation-code-snippets-dir=<dir>``
Directory used to search code snippets used by the documentation.
.. _documentation-data-dir:
``--documentation-data-dir=<dir>``
Directory with XML files generated by documentation tool.
.. _documentation-extra-sections-dir=<dir>:
``--documentation-extra-sections-dir=<dir>``
Directory used to search for extra documentation sections.
.. _library-source-dir:
``--library-source-dir=<dir>``
Directory where library source code is located.
.. _additional-documentation:
``--additional-documentation=<file>``
List of additional XML files to be converted to .rst files
(for example, tutorials).
|
