diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2022-11-01 14:54:30 +0100 |
|---|---|---|
| committer | Kai Köhne <kai.koehne@qt.io> | 2022-11-02 15:59:12 +0000 |
| commit | fea34864fd12f81272824790d8960c21c1c2597b (patch) | |
| tree | 55cd50dcb91e655087a51ea396fd37902811e9dc /src | |
| parent | 1be5acc3ec6e51b7ddb88368eadb464412a9a378 (diff) | |
Doc: Add overview pages to CMake API
Provide a landing page for InterfaceFramework commands and variables,
making it easier to navigate between them in the breadcrumb menu.
Also, add details on where the respective command is found.
Finally, for variables, normalize the .html name (this is done otherwise
by qdoc).
Pick-to: 6.4
Task-number: QTBUG-96239
Change-Id: I06411168f6bd0959a4a5a54ebf435718a167656a
Reviewed-by: Dominik Holland <dominik.holland@qt.io>
Diffstat (limited to 'src')
3 files changed, 49 insertions, 8 deletions
diff --git a/src/interfaceframework/doc/includes/cmake-find-package-interfaceframework.qdocinc b/src/interfaceframework/doc/includes/cmake-find-package-interfaceframework.qdocinc new file mode 100644 index 00000000..dcf33314 --- /dev/null +++ b/src/interfaceframework/doc/includes/cmake-find-package-interfaceframework.qdocinc @@ -0,0 +1,7 @@ +The command is defined in the \c InterfaceFramework component of the \c Qt6 package. + +Load the package with: + +\code +find_package(Qt6 REQUIRED COMPONENTS InterfaceFramework) +\endcode diff --git a/src/interfaceframework/doc/src/ifcodegen/cmake-macros.qdoc b/src/interfaceframework/doc/src/ifcodegen/cmake-macros.qdoc index 9f0efd41..56c773e7 100644 --- a/src/interfaceframework/doc/src/ifcodegen/cmake-macros.qdoc +++ b/src/interfaceframework/doc/src/ifcodegen/cmake-macros.qdoc @@ -2,14 +2,30 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! +\group cmake-commands-qtinterfaceframework +\title CMake Commands in Qt6 InterfaceFramework + +The following CMake commands are defined when Qt6::InterfaceFramework is loaded, for instance +with + +\code +find_package(Qt6 REQUIRED COMPONENTS InterfaceFramework) +\endcode + +\sa{CMake Command Reference} +*/ + +/*! \page cmake-qt-set-ifcodegen-variable.html -\ingroup cmake-macros-qtinterfaceframework +\ingroup cmake-commands-qtinterfaceframework \title qt_set_ifcodegen_variable \target qt6_set_ifcodegen_variable \summary {Sets the variable to the given \c value within an ifcodegen template.} +\include cmake-find-package-interfaceframework.qdocinc + \section1 Synopsis \badcode @@ -29,13 +45,15 @@ are exported to the current scope when using /*! \page cmake-qt-ifcodegen-generate.html -\ingroup cmake-macros-qtinterfaceframework +\ingroup cmake-commands-qtinterfaceframework \title qt_ifcodegen_generate \target qt6_ifcodegen_generate \summary {Generates files from a qface IDL file.} +\include cmake-find-package-interfaceframework.qdocinc + \section1 Synopsis \badcode @@ -94,13 +112,15 @@ For more details on the generator's command line arguments, see \l {Use the Gene /*! \page cmake-qt-ifcodegen-extend-target.html -\ingroup cmake-macros-qtinterfaceframework +\ingroup cmake-commands-qtinterfaceframework \title qt_ifcodegen_extend_target \target qt6_ifcodegen_extend_target \summary {Extends a target with files generated from a qface IDL file.} +\include cmake-find-package-interfaceframework.qdocinc + \section1 Synopsis \badcode @@ -144,13 +164,15 @@ For more details on the generator's command line arguments, see \l {Use the Gene /*! \page cmake-qt-ifcodegen-import-variables.html -\ingroup cmake-macros-qtinterfaceframework +\ingroup cmake-commands-qtinterfaceframework \title qt_ifcodegen_import_variables \target qt6_ifcodegen_import_variables \summary {Generates files from a qface IDL file and provides variables for use within CMake.} +\include cmake-find-package-interfaceframework.qdocinc + \section1 Synopsis \badcode diff --git a/src/interfaceframework/doc/src/ifcodegen/cmake-variables.qdoc b/src/interfaceframework/doc/src/ifcodegen/cmake-variables.qdoc index e62a96e2..073876dd 100644 --- a/src/interfaceframework/doc/src/ifcodegen/cmake-variables.qdoc +++ b/src/interfaceframework/doc/src/ifcodegen/cmake-variables.qdoc @@ -2,8 +2,21 @@ // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! -\page cmake-variable-QT_IFCODEGEN_TEMPLATE_SEARCH_PATH.html -\ingroup cmake-variables +\group cmake-variables-qtinterfaceframework +\title CMake Variables in Qt6 InterfaceFramework + +The following CMake variables are defined or influence commands that are part +of Qt6::InterfaceFramework: + +\code +find_package(Qt6 REQUIRED COMPONENTS InterfaceFramework) +\endcode + +\sa{CMake Variable Reference} +*/ + +/*! +\page cmake-variable-qt-ifcodegen-template-search-path.html \ingroup cmake-variables-qtinterfaceframework \title QT_IFCODEGEN_TEMPLATE_SEARCH_PATH @@ -22,8 +35,7 @@ search path. */ /*! -\page cmake-variable-IFCODEGEN_VERBOSE.html -\ingroup cmake-variables +\page cmake-variable-ifcodegen-verbose.html \ingroup cmake-variables-qtinterfaceframework \title IFCODEGEN_VERBOSE |