diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index 97e6fa7593d..99d1730cfe9 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -29,6 +29,7 @@ macro.QD = "Qt Designer" macro.QDS = "Qt Design Studio" macro.QDV = "Qt Design Viewer" macro.QL = "Qt Linguist" +macro.QMCU = "Qt for MCUs" macro.QMLD = "Qt Quick Designer" macro.QQV = "Qt QML Viewer" macro.QSDK = "Qt" diff --git a/doc/qtcreator/src/external-resources/external-resources.qdoc b/doc/qtcreator/src/external-resources/external-resources.qdoc index 7576aaf05fe..5d21be4257c 100644 --- a/doc/qtcreator/src/external-resources/external-resources.qdoc +++ b/doc/qtcreator/src/external-resources/external-resources.qdoc @@ -3,15 +3,15 @@ /*! \externalpage https://doc.qt.io/QtForMCUs/index.html - \title Qt for MCUs + \title \QMCU */ /*! \externalpage https://doc.qt.io/QtForMCUs/qtul-qmltypes.html - \title Qt for MCUs - All QML Types + \title \QMCU - All QML Types */ /*! \externalpage https://doc.qt.io/QtForMCUs/qtul-supported-platforms.html - \title Qt for MCUs - Supported Target Platforms + \title \QMCU - Supported Target Platforms */ /*! \externalpage https://doc.qt.io/QtForMCUs/qtul-getting-started-renesas.html diff --git a/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc b/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc index c441981d3b8..8f7a7378392 100644 --- a/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc +++ b/doc/qtcreator/src/linux-mobile/creator-embedded-platforms.qdoc @@ -90,7 +90,7 @@ \list \li \l{Connecting MCUs} \li \l{Running Applications on MCUs} - \li \l{https://doc.qt.io/QtForMCUs/index.html}{Qt for MCUs} + \li \l{https://doc.qt.io/QtForMCUs/index.html}{\QMCU} \endlist \section1 QNX diff --git a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc index 2719aa3e4c8..012a5d5e2eb 100644 --- a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc +++ b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc @@ -8,7 +8,7 @@ \title Connecting MCUs - Qt for MCU enables you to use subsets of QML and Qt Quick Controls + \QMCU enables you to use subsets of QML and Qt Quick Controls to create user interfaces for devices that are powered by microcontroller units (MCU). It includes a new graphics rendering engine that has a low memory footprint and is optimized for MCUs and other resource-constrained @@ -21,18 +21,18 @@ debug them using \QC. The toolchains are available for cross-compilation on Microsoft Windows, - Linux, and macOS. However, the Qt for MCU SDK is currently only available + Linux, and macOS. However, the Qt for \QMCU SDK is currently only available for Windows and Linux. - For a list of Qt for MCU reference implementations, see the - \l{Qt for MCUs - Supported Target Platforms}{Qt for MCUs} documentation. + For a list of \QMCU reference implementations, see the + \l{\QMCU - Supported Target Platforms}{\QMCU} documentation. \section1 Requirements To use \QC to develop QML applications for MCUs, you need the following: \list - \li Qt for MCU SDK (only available for Windows and Linux) + \li \QMCU SDK (only available for Windows and Linux) \li \l{https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm} {GNU ARM Embedded Toolchain} \endlist @@ -55,7 +55,7 @@ To be able to develop applications for MCUs, you need the MCU plugin. This plugin is enabled automatically by the Qt Installer when you - install Qt for MCUs. + install \QMCU. \section2 Specifying MCU Settings @@ -66,9 +66,9 @@ \image qtcreator-mcu-options.png "MCU preferences" \list 1 - \li In the \uicontrol {Qt for MCUs SDK} field, specify the path - to the directory where you installed Qt for MCUs SDK. - \li In the \uicontrol {Targets supported by the Qt for MCUs SDK} + \li In the \uicontrol {\QMCU SDK} field, specify the path + to the directory where you installed \QMCU SDK. + \li In the \uicontrol {Targets supported by the \QMCU SDK} field, select your MCU board. \li In the \uicontrol Requirements section, ensure that the platform-specific requirements are met. This varies depending @@ -105,7 +105,7 @@ \li Select \uicontrol Apply to save the settings. \endlist - \note When updating to other versions of the Qt for MCUs SDK, \QC will + \note When updating to other versions of the \QMCU SDK, \QC will ask you if you want to replace the existing kits, or create new ones alongside. This can also be done manually, for each individual target, via \uicontrol {Update Kit} and \uicontrol {Create Kit}, respectively. @@ -145,7 +145,7 @@ \uicontrol Preferences > \uicontrol Kits. However, for adding new kits you should use the \uicontrol {Create Kit} - button in the {Qt for MCUs} settings tab. This method adds the paths to + button in the {\QMCU} settings tab. This method adds the paths to the kit's toolkits and SDKs, and keeps them synchronized when selecting \uicontrol Apply or \uicontrol OK. @@ -156,14 +156,14 @@ You can use a wizard to set up a project for developing an application that you can run on MCUs. The project uses a subset of QML and Qt Quick Controls - that are supported by Qt for MCU. For more information about developing - applications for MCUs, see the Qt for MCU documentation. + that are supported by \QMCU. For more information about developing + applications for MCUs, see the \QMCU documentation. To create an application and run it on a MCU board: \list 1 \li Select \uicontrol File > \uicontrol {New Project} > - \uicontrol {Application (Qt for MCU)} > + \uicontrol {Application (\QMCU)} > \uicontrol {MCU Support Application} > \uicontrol Choose. \li Follow the instructions of the wizard to create the project. \li Select \uicontrol Projects > \uicontrol {Build & Run}, and then @@ -173,17 +173,17 @@ Usually, you can use the default settings. \endlist - \section1 Supported Qt for MCUs SDKs + \section1 Supported \QMCU SDKs - \note The Qt for MCUs SDK 2.3 requires \QC 9.0.0, or later. + \note The \QMCU SDK 2.3 requires \QC 9.0.0, or later. The following table lists the \QC versions you can use to develop - applications with particular Qt for MCUs SDK versions. + applications with particular \QMCU SDK versions. \table \header \li \QC version - \li Qt for MCUs SDK version + \li \QMCU SDK version \row \li 9.0.0 or later \li 2.0 or later diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc index 141e6eab2ad..8dd448e410b 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc @@ -79,10 +79,10 @@ \li Wizard Template \li Purpose \row - \li Application (Qt for MCU) + \li Application (\QMCU) \li MCU Support Application \li Creates an application that uses a subset of Qt QML and - Qt Quick Controls types (as supported by Qt for MCUs) that + Qt Quick Controls types (as supported by \QMCU) that you can deploy, run, and debug on MCU boards. For more information, see \l {Connecting MCUs}. \row diff --git a/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc b/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc index 45ab960f7d0..a003d922d47 100644 --- a/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc +++ b/doc/qtdesignstudio/examples/doc/washingMachineUI.qdoc @@ -33,15 +33,15 @@ In addition, all screens contain a small clock component that displays the current time. We implement a \e TimeDate JavaScript object to support this feature on \l{https://doc.qt.io/QtForMCUs/qtul-qmltypes.html} - {Qt for MCUs}, which does not support the \l Date component at the time of + {\QMCU}, which does not support the \l Date component at the time of writing. \section1 Creating an Application for MCUs - We use the \uicontrol {Qt for MCUs Application} project template to create + We use the \uicontrol {\QMCU Application} project template to create an application for MCUs, which support only a subset of the preset \l{glossary-component}{components}. We select \uicontrol File > - \uicontrol {New Project} > \uicontrol {Qt for MCUs Application} > + \uicontrol {New Project} > \uicontrol {\QMCU Application} > \uicontrol Choose, and follow the instructions of the wizard to create our project. @@ -54,16 +54,16 @@ that we can use to configure and build our example application for running it on MCUs. - \note This example has been tested to run using Qt for MCUs versions since + \note This example has been tested to run using \QMCU versions since 1.6. You cannot run it on older versions. Also, at the time of writing, - Qt for MCUs only supports Qt 5. + \QMCU only supports Qt 5. \section1 Creating Screens For this example, we used an external tool to design the UI and then exported and imported our design into \QDS as assets and components using \QB, as instructed in \l{Exporting from Design Tools}. While - exporting, we only picked components supported by Qt for MCUs to use + exporting, we only picked components supported by \QMCU to use for our components. For the button components, we mostly use the \l {basic-image}{Image}, \l Text, and \l {Mouse Area} components. For the screen background, we use the \l {basic-rectangle}{Rectangle} component. @@ -171,7 +171,7 @@ \image washingmachineui-states.png "States view" - In Qt for MCU, states work differently from Qt Quick, and therefore we + In \QMCU, states work differently from Qt Quick, and therefore we sometimes use \c when conditions to determine the state to apply, and sometimes switch states using signals and JavaScript expressions. @@ -217,7 +217,7 @@ \section1 Showing the Current Time - The \l Date component is not supported on Qt for MCUs, and the + The \l Date component is not supported on \QMCU, and the \l{https://doc.qt.io/QtForMCUs/qtul-javascript-environment.html} {implementation of the JavaScript \c Date()} object returns elapsed time since when the application was started instead of the current diff --git a/doc/qtdesignstudio/src/components/qtquick-mcu-support.qdocinc b/doc/qtdesignstudio/src/components/qtquick-mcu-support.qdocinc index e01af788b80..edd75e3a467 100644 --- a/doc/qtdesignstudio/src/components/qtquick-mcu-support.qdocinc +++ b/doc/qtdesignstudio/src/components/qtquick-mcu-support.qdocinc @@ -6,9 +6,9 @@ \section1 Creating UIs for MCUs - \l{Qt for MCUs} enables you to use subsets of components to create UIs for + \l{\QMCU} enables you to use subsets of components to create UIs for devices that are powered by microcontroller units (MCU). The subset of - supported components depends on the Qt for MCUs version that you use for + supported components depends on the \QMCU version that you use for development. In this manual, we indicate which components are supported at the time of writing. @@ -21,7 +21,7 @@ \image qmldesigner-mcu-support.png "Components and Text properties supported for MCUs" For more information about the supported components and their properties, - see \l{Qt for MCUs - All QML Types}. + see \l{\QMCU - All QML Types}. //! [mcu qtquick components] */ diff --git a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc index ffb23d35f2e..1aab65187ab 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-projects.qdoc @@ -47,10 +47,10 @@ \li Creates a project that uses default and 3D components such as cameras, lights, 3D models, and materials. \row - \li Qt for MCUs + \li \QMCU \li MCU \li Creates an application that uses a subset of default components - (as supported by Qt for MCUs) that you can deploy, run, and debug + (as supported by \QMCU) that you can deploy, run, and debug on MCU boards. \row \li {1,3} Mobile