diff options
Diffstat (limited to 'sources/shiboken6/doc/typesystem_solving_compilation.rst')
| -rw-r--r-- | sources/shiboken6/doc/typesystem_solving_compilation.rst | 98 |
1 files changed, 50 insertions, 48 deletions
diff --git a/sources/shiboken6/doc/typesystem_solving_compilation.rst b/sources/shiboken6/doc/typesystem_solving_compilation.rst index 4b8a05447..705c2cd26 100644 --- a/sources/shiboken6/doc/typesystem_solving_compilation.rst +++ b/sources/shiboken6/doc/typesystem_solving_compilation.rst @@ -6,73 +6,75 @@ Solving compilation problems suppress-warning ^^^^^^^^^^^^^^^^ - The generator will generate several warnings which may be irrelevant to the - user. The ``suppress-warning`` node suppresses the specified warning, and it is - a child of the :ref:`typesystem` node. +The generator will generate several warnings which may be irrelevant to the +user. The ``suppress-warning`` node suppresses the specified warning, and it is +a child of the :ref:`typesystem` node. - .. code-block:: xml +.. code-block:: xml - <typesystem> - <suppress-warning text="..." /> - </typesystem> + <typesystem> + <suppress-warning text="..." /> + </typesystem> - The **text** attribute is the warning text to suppress, and may contain the * - wildcard (use "" to escape regular expression matching if the warning contain - a regular "*"). +The **text** attribute is the warning text to suppress, and may contain the * +wildcard (use "" to escape regular expression matching if the warning contain +a regular "*"). .. _extra-includes: extra-includes ^^^^^^^^^^^^^^ - The ``extra-includes`` node contains declarations of additional include files, - and it can be a child of the :ref:`namespace`, :ref:`value-type`, - :ref:`object-type` and :ref:`typesystem` and nodes. +The ``extra-includes`` node contains declarations of additional include files, +and it can be a child of the :ref:`namespace`, :ref:`value-type`, +:ref:`object-type` and :ref:`typesystem` and nodes. - The generator automatically tries to read the global header for each type but - sometimes it is required to include extra files in the generated C++ code to - make sure that the code compiles. These files must be listed using include - nodes within the extra-include node: +The generator automatically tries to read the global header for each type but +sometimes it is required to include extra files in the generated C++ code to +make sure that the code compiles. These files must be listed using include +nodes within the extra-include node: - .. code-block:: xml +.. code-block:: xml - <value-type> - <extra-includes> - <include file-name="..." location="global | local"/> - </extra-includes> - </value-type> + <value-type> + <extra-includes> + <include file-name="..." location="global | local"/> + </extra-includes> + </value-type> - The **file-name** attribute is the file to include, such as "QStringList". - The **location** attribute is where the file is located: *global* means that - the file is located in $INCLUDEPATH and will be included using #include <...>, - *local* means that the file is in a local directory and will be included - using #include "...". +The **file-name** attribute is the file to include, such as "QStringList". +The **location** attribute is where the file is located: *global* means that +the file is located in $INCLUDEPATH and will be included using #include <...>, +*local* means that the file is in a local directory and will be included +using #include "...". - When specified as a child of the :ref:`typesystem` node, the include - directives are added to the module source file which contains - the type converter and registration code. It can be used to specify - additional includes required for the converter code snippets. +When specified as a child of the :ref:`typesystem` node, the include +directives are added to the module source file which contains +the type converter and registration code. It can be used to specify +additional includes required for the converter code snippets. + +.. _include-element: include ^^^^^^^ - The ``include`` node specifies the name and location of a file that must be - included, and it is a child of the :ref:`namespace`, :ref:`value-type`, - :ref:`object-type` or :ref:`extra-includes` node. +The ``include`` node specifies the name and location of a file that must be +included, and it is a child of the :ref:`namespace`, :ref:`value-type`, +:ref:`object-type` or :ref:`extra-includes` node. - The generator automatically tries to read the global header for each type. Use - the include node to override this behavior, providing an alternative file. The - include node can also be used to specify extra include files. +The generator automatically tries to read the global header for each type. Use +the include node to override this behavior, providing an alternative file. The +include node can also be used to specify extra include files. - .. code-block:: xml +.. code-block:: xml - <value-type> - <include file-name="..." - location="global | local"/> - </value-type> + <value-type> + <include file-name="..." + location="global | local"/> + </value-type> - The **file-name** attribute is the file to include, such as "QStringList". - The **location** attribute is where the file is located: *global* means that - the file is located in $INCLUDEPATH and will be included using #include <...>, - *local* means that the file is in a local directory and will be included - using #include "...". +The **file-name** attribute is the file to include, such as "QStringList". +The **location** attribute is where the file is located: *global* means that +the file is located in $INCLUDEPATH and will be included using #include <...>, +*local* means that the file is in a local directory and will be included +using #include "...". |