Document the new format of the EXPORT_MACRO option

Add documentation that describes the new format of EXPORT_MACRO
that we introduced in Qt 6.7 already but want make it public in
Qt 6.8 only.

Change-Id: I3431668c3f4949b493f18f0401183fbdcb18c827
Reviewed-by: Tatiana Borisova <tatiana.borisova@qt.io>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Alexey Edelev 2024-02-04 00:33:04 +01:00
parent e37ef959da
commit 57e09d6092
1 changed files with 6 additions and 2 deletions

View File

@ -12,5 +12,9 @@ namespace.
\li \c EXPORT_MACRO is the base name of the symbol export macro used for
the generated code. The generated macro name is constructed as
\c QPB_<EXPORT_MACRO>_EXPORT. If the option is not set, the macro is not
generated.
generated. Since Qt 6.8, \c EXPORT_MACRO supports the following format:
\c {EXPORT_MACRO=macro_name[:macro_output_file[:<true|false>]]}. The new format
allows you to set the generated macro file name and explicitly enable or disable
the generation of the file containing the macro definitions. If
\c macro_output_file is not set, the option falls back to the old syntax
handling.