diff options
Diffstat (limited to 'doc')
22 files changed, 105 insertions, 40 deletions
diff --git a/doc/api/examples/exampleplugin/example_global.h b/doc/api/examples/exampleplugin/example_global.h index 228343cdf0..00c77e6b16 100644 --- a/doc/api/examples/exampleplugin/example_global.h +++ b/doc/api/examples/exampleplugin/example_global.h @@ -1,5 +1,4 @@ -#ifndef EXAMPLE_GLOBAL_H -#define EXAMPLE_GLOBAL_H +#pragma once #include <QtGlobal> @@ -8,6 +7,3 @@ #else # define EXAMPLESHARED_EXPORT Q_DECL_IMPORT #endif - -#endif // EXAMPLE_GLOBAL_H - diff --git a/doc/api/examples/exampleplugin/exampleconstants.h b/doc/api/examples/exampleplugin/exampleconstants.h index 1fe6b83bc1..fced2e0429 100644 --- a/doc/api/examples/exampleplugin/exampleconstants.h +++ b/doc/api/examples/exampleplugin/exampleconstants.h @@ -1,5 +1,4 @@ -#ifndef EXAMPLECONSTANTS_H -#define EXAMPLECONSTANTS_H +#pragma once namespace Example { namespace Constants { @@ -9,6 +8,3 @@ const char MENU_ID[] = "Example.Menu"; } // namespace Example } // namespace Constants - -#endif // EXAMPLECONSTANTS_H - diff --git a/doc/api/examples/exampleplugin/exampleplugin.h b/doc/api/examples/exampleplugin/exampleplugin.h index 56f04ea746..e858e92180 100644 --- a/doc/api/examples/exampleplugin/exampleplugin.h +++ b/doc/api/examples/exampleplugin/exampleplugin.h @@ -1,5 +1,4 @@ -#ifndef EXAMPLE_H -#define EXAMPLE_H +#pragma once #include "example_global.h" @@ -35,6 +34,3 @@ private: } // namespace Internal } // namespace Example - -#endif // EXAMPLE_H - diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf index 401563e7ab..50986a4c4b 100644 --- a/doc/config/qtcreator-project.qdocconf +++ b/doc/config/qtcreator-project.qdocconf @@ -7,6 +7,7 @@ sourcedirs = $SRCDIR/src imagedirs = $SRCDIR/images \ $SRCDIR/templates/images \ $SRCDIR/../src/libs/qmleditorwidgets/images \ + $SRCDIR/../src/libs/utils/images \ $SRCDIR/../src/plugins/android/images \ $SRCDIR/../src/plugins/autotest/images \ $SRCDIR/../src/plugins/classview/images \ diff --git a/doc/doc.pri b/doc/doc.pri index d04712aba6..207788a0f1 100644 --- a/doc/doc.pri +++ b/doc/doc.pri @@ -66,20 +66,18 @@ dev_html_docs_online.depends += $$DEV_HELP_DEP_FILES dev_qch_docs.commands = $$HELPGENERATOR -o \"$$DEV_QCH_FILE\" $$DEV_QHP_FILE dev_qch_docs.depends += dev_html_docs -!macx { - inst_qch_docs.files = $$QCH_FILE - inst_qch_docs.path = $$INSTALL_DOC_PATH - inst_qch_docs.CONFIG += no_check_exist no_default_install - INSTALLS += inst_qch_docs - - inst_dev_qch_docs.files = $$DEV_QCH_FILE - inst_dev_qch_docs.path = $$INSTALL_DOC_PATH - inst_dev_qch_docs.CONFIG += no_check_exist no_default_install - INSTALLS += inst_dev_qch_docs - - install_docs.depends = install_inst_qch_docs install_inst_dev_qch_docs - QMAKE_EXTRA_TARGETS += install_docs -} +inst_qch_docs.files = $$QCH_FILE +inst_qch_docs.path = $$INSTALL_DOC_PATH +inst_qch_docs.CONFIG += no_check_exist no_default_install +INSTALLS += inst_qch_docs + +inst_dev_qch_docs.files = $$DEV_QCH_FILE +inst_dev_qch_docs.path = $$INSTALL_DOC_PATH +inst_dev_qch_docs.CONFIG += no_check_exist no_default_install +INSTALLS += inst_dev_qch_docs + +install_docs.depends = install_inst_qch_docs install_inst_dev_qch_docs +QMAKE_EXTRA_TARGETS += install_docs docs_online.depends = html_docs_online dev_html_docs_online docs.depends = qch_docs dev_qch_docs diff --git a/doc/doc.qbs b/doc/doc.qbs new file mode 100644 index 0000000000..79220618da --- /dev/null +++ b/doc/doc.qbs @@ -0,0 +1,55 @@ +import qbs + +Project { + name: "documentation" + + QtcDocumentation { + name: "user doc online" + isOnlineDoc: true + mainDocConfFile: "qtcreator-online.qdocconf" + + files: [ + "src/**/*", + ] + } + + QtcDocumentation { + name: "user doc offline" + isOnlineDoc: false + mainDocConfFile: "qtcreator.qdocconf" + + files: [ + "src/**/*", + ] + } + + QtcDocumentation { + name: "API doc online" + isOnlineDoc: true + mainDocConfFile: "api/qtcreator-dev-online.qdocconf" + + Group { + name: "sources" + files: [ + "api/*.qdoc", + "api/**/*", + ] + excludeFiles: [mainDocConfFile] + } + } + + QtcDocumentation { + name: "API doc offline" + isOnlineDoc: false + mainDocConfFile: "api/qtcreator-dev.qdocconf" + + Group { + name: "sources" + files: [ + "api/*.qdoc", + "api/**/*", + ] + excludeFiles: [mainDocConfFile] + } + } +} diff --git a/doc/examples/textfinder/textfinder.h b/doc/examples/textfinder/textfinder.h index 26182be9f4..8351a47377 100644 --- a/doc/examples/textfinder/textfinder.h +++ b/doc/examples/textfinder/textfinder.h @@ -48,8 +48,7 @@ ** ****************************************************************************/ -#ifndef TEXTFINDER_H -#define TEXTFINDER_H +#pragma once #include "ui_textfinder.h" @@ -77,5 +76,3 @@ private: void loadTextFile(); //! [0] }; - -#endif // TEXTFINDER_H diff --git a/doc/images/numbers/01.png b/doc/images/numbers/01.png Binary files differindex dc07d223fa..d73ab969bb 100644 --- a/doc/images/numbers/01.png +++ b/doc/images/numbers/01.png diff --git a/doc/images/numbers/02.png b/doc/images/numbers/02.png Binary files differindex 9cbb73a4f7..d0b4cfafe9 100644 --- a/doc/images/numbers/02.png +++ b/doc/images/numbers/02.png diff --git a/doc/images/numbers/03.png b/doc/images/numbers/03.png Binary files differindex 5fb99f0167..752373f918 100644 --- a/doc/images/numbers/03.png +++ b/doc/images/numbers/03.png diff --git a/doc/images/numbers/04.png b/doc/images/numbers/04.png Binary files differindex 424d82e154..08fe1b8209 100644 --- a/doc/images/numbers/04.png +++ b/doc/images/numbers/04.png diff --git a/doc/images/numbers/05.png b/doc/images/numbers/05.png Binary files differindex 7b6344fe10..186dd97519 100644 --- a/doc/images/numbers/05.png +++ b/doc/images/numbers/05.png diff --git a/doc/images/numbers/06.png b/doc/images/numbers/06.png Binary files differindex 0f01f2cfd4..f9454a7467 100644 --- a/doc/images/numbers/06.png +++ b/doc/images/numbers/06.png diff --git a/doc/images/numbers/07.png b/doc/images/numbers/07.png Binary files differindex b0390aa5c8..0f18d811ce 100644 --- a/doc/images/numbers/07.png +++ b/doc/images/numbers/07.png diff --git a/doc/images/numbers/08.png b/doc/images/numbers/08.png Binary files differindex 803f3c2739..463f770167 100644 --- a/doc/images/numbers/08.png +++ b/doc/images/numbers/08.png diff --git a/doc/images/numbers/09.png b/doc/images/numbers/09.png Binary files differindex 83994f2555..823c5c0dba 100644 --- a/doc/images/numbers/09.png +++ b/doc/images/numbers/09.png diff --git a/doc/images/numbers/10.png b/doc/images/numbers/10.png Binary files differindex 22c5ea5a1b..d689be3fac 100644 --- a/doc/images/numbers/10.png +++ b/doc/images/numbers/10.png diff --git a/doc/src/analyze/qtquick-profiler.qdoc b/doc/src/analyze/qtquick-profiler.qdoc index 9d674fae77..8fe52046e1 100644 --- a/doc/src/analyze/qtquick-profiler.qdoc +++ b/doc/src/analyze/qtquick-profiler.qdoc @@ -368,8 +368,7 @@ \li GUI \li Threaded \li blockedForSync - \li The time the GUI thread is blocked, waiting for the render thread - to synchronize the QML state into the scene graph. + \li The time the GUI thread is blocked, waiting for the render thread. \li None \row \li \uicontrol {Animations} diff --git a/doc/src/debugger/qtquick-debugging.qdoc b/doc/src/debugger/qtquick-debugging.qdoc index d11f5a439b..003429dc5b 100644 --- a/doc/src/debugger/qtquick-debugging.qdoc +++ b/doc/src/debugger/qtquick-debugging.qdoc @@ -216,6 +216,10 @@ application to jump to their definitions in the code. The properties of the selected item are displayed in the \uicontrol {Locals and Expressions} view. + The \uicontrol Select tool will be enabled either if your application is + using Qt 5.7 or later, or if your application is using an earlier version + of Qt and is based on the \c QQuickView class. + You can also view the item hierarchy in the running application: \list diff --git a/doc/src/editors/creator-beautifier.qdoc b/doc/src/editors/creator-beautifier.qdoc index e5c67869e8..76c3d18d21 100644 --- a/doc/src/editors/creator-beautifier.qdoc +++ b/doc/src/editors/creator-beautifier.qdoc @@ -81,10 +81,14 @@ \image beautifier_options.png - \li In the \uicontrol {Artistic Style command}, + \li In the \uicontrol Configuration group, specify the path to + the tool executable in the \uicontrol {Artistic Style command}, \uicontrol {Clang Format command}, or - \uicontrol {Uncrustify command} field, specify the path to the tool - executable. + \uicontrol {Uncrustify command} field. + + \li In the \uicontrol {Restrict to MIME types} field, define the MIME + types of the files to beautify, separated by semicolons. Leave the + field empty to apply the tool on all files. \li In the \uicontrol Options group, select the configuration file that defines the style to use in the source files. If you select several @@ -129,4 +133,21 @@ file in this case when using Clang, select the \uicontrol {Format entire file if no text was selected} check box in the \uicontrol {Clang Format} options. + + To automatically format files when they are saved, select \uicontrol Tools > + \uicontrol Beautifier > \uicontrol General: + + \list 1 + + \li In the \uicontrol Tool field, select the tool for formatting. + + \li In the \uicontrol {Restrict to MIME types} field, specify a + semicolon-separated list of MIME types. One of these types must + match the MIME type of the file that is auto formatted. + An empty list accepts all files. + + \li Select the \uicontrol {Restrict to files contained in the current + project} check box to only auto format files in the current project. + + \endlist */ diff --git a/doc/src/projects/creator-projects-cmake.qdoc b/doc/src/projects/creator-projects-cmake.qdoc index 857a371d21..1ccf4f55fd 100644 --- a/doc/src/projects/creator-projects-cmake.qdoc +++ b/doc/src/projects/creator-projects-cmake.qdoc @@ -49,7 +49,9 @@ \section1 Adding CMake Tools - \QC supports CMake version 3.0, or later. + \QC supports CMake version 3.0, or later. For best results you should use + CMake version 3.3.2 or later. Earlier versions provide less information + to the code model, which will then fail to resolve includes and defines. To specify paths to CMake executables and to add them to kits: diff --git a/doc/src/projects/creator-projects-targets.qdoc b/doc/src/projects/creator-projects-targets.qdoc index 41a79f5fcc..2871f3a869 100644 --- a/doc/src/projects/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-projects-targets.qdoc @@ -97,7 +97,7 @@ automatically. For more information, see \l{Adding Compilers}. \li In the \uicontrol Environment field, select \uicontrol Change to modify - environment variable values for build and run environments in + environment variable values for build environments in the \uicontrol {Edit Environment Changes} dialog. For more information about how to add and remove variable values, see \l{Batch Editing}. |
