diff options
author | Hugo Lima <hugo.lima@openbossa.org> | 2009-10-17 13:41:44 -0300 |
---|---|---|
committer | Hugo Lima <hugo.lima@openbossa.org> | 2009-10-17 13:41:44 -0300 |
commit | 51168e70b530c6920411680d5e6dde7aeaba164c (patch) | |
tree | 96d90b12ee2115030d7d86724e703ad612b595e3 /doc/typesystem_solving_compilation.rst | |
parent | 705b3f37e76b59d020d24b76600a8b21d319326d (diff) |
- Typesystem documentation broken in smaller parts, so it's more redable now (IMO).
- Added cross referencing for nodes cited along the documentation.
- Added documentation for the new and not implemented yet, add-function tag.
Diffstat (limited to 'doc/typesystem_solving_compilation.rst')
-rw-r--r-- | doc/typesystem_solving_compilation.rst | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/doc/typesystem_solving_compilation.rst b/doc/typesystem_solving_compilation.rst new file mode 100644 index 000000000..81d14a187 --- /dev/null +++ b/doc/typesystem_solving_compilation.rst @@ -0,0 +1,70 @@ +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 typesystem node. + + .. code-block:: xml + + <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 "*"). + +extra-includes +^^^^^^^^^^^^^^ + + The extra-includes node contains declarations of additional include files, + and it can be a child of the interface-type, namespace-type, value-type and + object-type 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 witin the extra-include node: + + .. code-block:: xml + + <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 "...". + + +include +^^^^^^^ + + The include node specifies the name and location of a file that must be + included, and it is a child of the interface-type, namespace-type, value-type, + object-type or extra-includes nodes + + 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 + + <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 "...". |