diff options
Diffstat (limited to 'doc')
50 files changed, 1063 insertions, 232 deletions
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 86aca0324f..9ec6cb6799 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,14 +1,13 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: BSD-3-Clause -# special case skip regeneration # # Copy/Install doc configuration files to the build/install directory # qt_path_join(doc_install_dir ${QT_INSTALL_DIR} ${INSTALL_DOCDIR}) foreach(dir global config) qt_copy_or_install(DIRECTORY ${dir} DESTINATION ${doc_install_dir}) - if(QT_SUPERBUILD) + if(QT_SUPERBUILD OR "${PROJECT_NAME}" STREQUAL "QtBase") qt_path_join(destination ${QtBase_BINARY_DIR} ${INSTALL_DOCDIR}) file(COPY ${dir} DESTINATION ${destination}) endif() diff --git a/doc/README b/doc/README deleted file mode 100644 index ed8410db71..0000000000 --- a/doc/README +++ /dev/null @@ -1,109 +0,0 @@ -Qt 5 Documentation -================== - -New in Qt 5.0, each module has its own documentation package. The documentation -resides in the module sources as well as the configuration files needed to build -the module documentation. The main Qt 5.0 Reference Documentation resides in the -qtdoc repository. - -There are two ways to build Qt documentation: -* run "make docs" in qt5/ or in the repositories -* run the QDoc tool for each module - - -Running "make docs" -=================== - -To build the documentation using Makefiles, qtbase needs to be compiled and -installed. - -Running qmake will create make targets to build the documentation: -* html_docs - builds only the HTML documentation -* qch_docs - packages the HTML documentation into QCH files for Qt Creator and - Qt Assistant. -* docs - runs html_docs and qch_docs - -Note: qch_docs needs qhelpgenerator to package the documentation. qhelpgenerator -is in the qttools repository. - -These make targets use qmake's QT_INSTALL_DOCS variable as the output directory. -Running "qmake -query" will list the directory set to QT_INSTALL_DOCS. - -To create all of the modules' documentation, run "make docs" in the -qt5 directory: - $> make docs # builds the bundled modules' documentation - -It is also possible to build only a small subset of the documentation by using -make: - $> cd qtbase - $> make docs # builds the documentation for modules in qtbase - - $> cd qtbase/src/sql - $> make docs # builds only the Qt SQL documentation - - -Running QDoc -============ - -QDoc is the tool for generating Qt documentation and is located in qtbase. -The simplest way to compile QDoc is to compile qtbase or only the tools in -qtbase. - - $> cd qtbase/src - $> make sub-tools # compiles QDoc - -Each module has a QDoc configuration file (.qdocconf). To build a module's -documentation, run the "qdoc" binary and pass the qdocconf file as a parameter. -A mandatory "outputdir" must be specified. - - $> qdoc doc/config/qtdoc.qdocconf -outputdir html - - Note that QDoc will delete the contents of the "html" output directory. - -Packaging the Documentation -=========================== - -To package the documentation, the HTML files must be compiled -into a QCH file (.qch). - -Required binaries: - * assistant - found in qttools - * qhelpgenerator - found in qttools - -To compile the qch file for each module, first enter the output directory that -contains the .qhp file and generate the QCH file. - - $> cd qtbase/doc/qtdoc #the default path for QT_INSTALL_DOCS for qtdoc - $> qhelpgenerator qtdoc.qhp #creates the QCH file called qtdoc.qch - -The QCH file can then be loaded in Qt Assistant or Qt Creator. For Qt Assistant, -the QCH file can be registered to automatically load it. - - $> assistant -register qtdoc.qch #to automatically load the documentation - - -Global Files -============ - -The qtbase/doc/global directory contains various files used by the modules to -build the documentation. These include macros, stylesheets, and images for -displaying documentation. - -To include these files in a qdocconf, add the following to a qdocconf file: - - include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) - - -Documentation Structure -======================= -For a typical module, the documentation will reside in the source directory. -The examples and the example documentation are in the "examples" directory. - - qtbase/src/sql/doc/src #Qt SQL's documentation - qtbase/examples/sql #Qt SQL's examples - -More Information -================ - -For more information about Qt 5's documentation, refer to the Qt Project wiki: -http://wiki.qt.io/Qt5DocumentationProject diff --git a/doc/config/exampleurl-qtpositioning.qdocconf b/doc/config/exampleurl-qtpositioning.qdocconf new file mode 100644 index 0000000000..f8fd478e93 --- /dev/null +++ b/doc/config/exampleurl-qtpositioning.qdocconf @@ -0,0 +1 @@ +url.examples = "https://code.qt.io/cgit/qt/qtpositioning.git/tree/examples/\1?h=$QT_VER" diff --git a/doc/config/exampleurl-qtquickcontrols2.qdocconf b/doc/config/exampleurl-qtquickcontrols2.qdocconf index 3e2749ec65..4b1d751b60 100644 --- a/doc/config/exampleurl-qtquickcontrols2.qdocconf +++ b/doc/config/exampleurl-qtquickcontrols2.qdocconf @@ -1 +1 @@ -url.examples = "https://code.qt.io/cgit/qt/qtquickcontrols2.git/tree/examples/\1?h=$QT_VER" +url.examples = "https://code.qt.io/cgit/qt/qtdeclarative.git/tree/examples/\1?h=$QT_VER" diff --git a/doc/global/config.qdocconf b/doc/global/config.qdocconf index 06e3565101..1ed2160522 100644 --- a/doc/global/config.qdocconf +++ b/doc/global/config.qdocconf @@ -3,7 +3,7 @@ dita.metadata.default.author = Qt Project dita.metadata.default.permissions = all dita.metadata.default.publisher = Qt Project -dita.metadata.default.copyryear = 2022 +dita.metadata.default.copyryear = 2024 dita.metadata.default.copyrholder = The Qt Company Ltd dita.metadata.default.audience = programmer @@ -19,8 +19,8 @@ ignorewords += \ WebSockets \ OpenGL -# Omit \since information for items introduced before Qt 5 -ignoresince = 5.0 +# Omit \since information for items introduced before Qt 6 +ignoresince = 6.0 sourcedirs += includes $$BUILDDIR exampledirs += snippets @@ -29,6 +29,11 @@ url = https://doc.qt.io/qt defines += qt6 -# Uncomment the following two lines to generate documentation marked as \internal -# alias.internal = disable -# macro.internal.HTML = "<span style="color:red">[internal]</span>" +# Require Qt modules to define qhp.projects +qhp = true + +# Disable writing host-specific paths into .index files +locationinfo = false + +# Include the warninglimit used for documentation testing in CI +include(warninglimit.qdocconf) diff --git a/doc/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc index 292105efb4..272c73b3b0 100644 --- a/doc/global/externalsites/external-resources.qdoc +++ b/doc/global/externalsites/external-resources.qdoc @@ -117,6 +117,11 @@ */ /*! + \externalpage https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html + \title CMake BUILD_SHARED_LIBS Documentation +*/ + +/*! \externalpage https://conan.io/ \title Conan */ @@ -563,6 +568,11 @@ */ /*! - \externalpage https://www.froglogic.com/testcenter/ - \title Squish Test Center + \externalpage https://www.qt.io/product/quality-assurance/test-center + \title Test Center +*/ + +/*! + \externalpage https://specifications.freedesktop.org/trash-spec/trashspec-1.0.html + \title FreeDesktop.org Trash specification version 1.0 */ diff --git a/doc/global/fileextensions.qdocconf b/doc/global/fileextensions.qdocconf index ca036619f1..cf9c6688c0 100644 --- a/doc/global/fileextensions.qdocconf +++ b/doc/global/fileextensions.qdocconf @@ -3,7 +3,7 @@ outputencoding = UTF-8 sourceencoding = UTF-8 examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml *.css *.glsl" -examples.imageextensions = "*.png *.jpg *.gif" +examples.imageextensions = "*.png *.jpg *.gif *.webp" headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx" sources.fileextensions = "*.c++ *.cc *.cpp *.cxx *.mm *.qml *.qdoc" diff --git a/doc/global/html-config.qdocconf b/doc/global/html-config.qdocconf index 9b3b05b7d3..216f3a50cf 100644 --- a/doc/global/html-config.qdocconf +++ b/doc/global/html-config.qdocconf @@ -18,7 +18,8 @@ HTML.extraimages += template/images/arrow_bc.png \ #specify which files in the output directory should be packed into the qch file. #these files are assumed to be in each module's output directory."qtquick/images/ico_out.png" for example. -qhp.extraFiles += images/arrow_bc.png \ +{qhp.extraFiles,DocBook.extraFiles} += \ + images/arrow_bc.png \ images/home.png \ images/ico_out.png \ images/ico_note.png \ @@ -29,3 +30,4 @@ qhp.extraFiles += images/arrow_bc.png \ images/bullet_sq.png \ images/bgrContent.png \ images/logo.png + diff --git a/doc/global/html-footer-online.qdocconf b/doc/global/html-footer-online.qdocconf index 523d228b93..6da298418b 100644 --- a/doc/global/html-footer-online.qdocconf +++ b/doc/global/html-footer-online.qdocconf @@ -78,7 +78,7 @@ HTML.footer += \ " <ul id=\"menu-footer-submenu\" class=\"right clearfix\"><li id=\"menu-item-1795\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-1795\"><a title=\"Sign into your account.\" href=\"https://account.qt.io/login\">Sign In</a></li>\n" \ " <li id=\"menu-item-10375\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-10375\"><a href=\"mailto:feedback@theqtcompany.com?Subject=Feedback%20about%20doc.qt.io%20site\">Feedback</a></li>\n" \ " <li id=\"menu-item-1494\" class=\"menu-item menu-item-type-post_type menu-item-object-page menu-item-1494\"><a href=\"http://qt.io/contact-us/\">Contact us</a></li>\n" \ - " <li id=\"menu-item-4472\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-4472\"><a href=\"http://qt.io/about-us/\">© 2022 The Qt Company</a></li>\n" \ + " <li id=\"menu-item-4472\" class=\"menu-item menu-item-type-custom menu-item-object-custom menu-item-4472\"><a href=\"http://qt.io/about-us/\">© 2024 The Qt Company</a></li>\n" \ " </ul>\n" \ "</div>\n" \ "</div>\n" \ diff --git a/doc/global/html-footer.qdocconf b/doc/global/html-footer.qdocconf index f799534c58..75626af645 100644 --- a/doc/global/html-footer.qdocconf +++ b/doc/global/html-footer.qdocconf @@ -8,13 +8,13 @@ HTML.footer = \ "</div>\n" \ "<div class=\"footer\">\n" \ " <p>\n" \ - " <acronym title=\"Copyright\">©</acronym> 2022 The Qt Company Ltd.\n" \ + " <abbr title=\"Copyright\">©</abbr> 2024 <span translate=\"no\">The Qt Company Ltd.</span>\n" \ " Documentation contributions included herein are the copyrights of\n" \ " their respective owners.<br/>" \ " The documentation provided herein is licensed under the terms of the" \ " <a href=\"http://www.gnu.org/licenses/fdl.html\">GNU Free Documentation" \ - " License version 1.3</a> as published by the Free Software Foundation.<br/>" \ - " Qt and respective logos are <a href=\"https://doc.qt.io/qt/trademarks.html\">" \ - " trademarks</a> of The Qt Company Ltd. in Finland and/or other countries\n" \ + " License version 1.3</a> as published by the <span translate=\"no\">Free Software Foundation</span>.<br/>" \ + " <span translate=\"no\">Qt</span> and respective logos are <a href=\"https://doc.qt.io/qt/trademarks.html\">" \ + " trademarks</a> of <span translate=\"no\">The Qt Company Ltd.</span> in Finland and/or other countries\n" \ " worldwide. All other trademarks are property of their respective owners. </p>\n" \ "</div>\n" \ diff --git a/doc/global/html-header-offline.qdocconf b/doc/global/html-header-offline.qdocconf index d84f38fef8..ffce22eeee 100644 --- a/doc/global/html-header-offline.qdocconf +++ b/doc/global/html-header-offline.qdocconf @@ -1,10 +1,14 @@ #Default HTML header for QDoc builds. #specify the CSS file used by this template -HTML.stylesheets = template/style/offline.css +HTML.stylesheets = template/style/offline.css \ + template/style/offline-dark.css \ + template/style/tech_preview.svg #for including files into the qch file -qhp.extraFiles += style/offline.css +qhp.extraFiles += style/offline.css \ + style/offline-dark.css \ + style/tech_preview.svg HTML.headerstyles = \ " <link rel=\"stylesheet\" type=\"text/css\" href=\"style/offline.css\" />\n" diff --git a/doc/global/html-header-online.qdocconf b/doc/global/html-header-online.qdocconf index d674e76bb0..8d258c2a27 100644 --- a/doc/global/html-header-online.qdocconf +++ b/doc/global/html-header-online.qdocconf @@ -11,8 +11,10 @@ HTML.stylesheets = template/style/online.css \ template/style/icomoon.woff \ template/style/cookiebar-x.png \ template/style/doc_search.png \ + template/style/tech_preview.svg \ template/style/theqtcompany.png + #for including files into the qch file. Relative to the outputdir of a QDoc build. qhp.extraFiles += style/online.css \ style/cookie-confirm.css \ @@ -25,6 +27,7 @@ qhp.extraFiles += style/online.css \ style/icomoon.woff \ style/cookiebar-x.png \ style/doc_search.png \ + style/tech_preview.svg \ style/theqtcompany.png HTML.headerstyles = \ diff --git a/doc/global/includes/module-use.qdocinc b/doc/global/includes/module-use.qdocinc index 747148b254..234d79c305 100644 --- a/doc/global/includes/module-use.qdocinc +++ b/doc/global/includes/module-use.qdocinc @@ -18,9 +18,10 @@ //! [using qt module] //! [using the c++ api] - Using a Qt module requires linking against the module library, either - directly or through other dependencies. Several build tools have dedicated - support for this, including \l{CMake Documentation}{CMake} and \l{qmake}. + Using a Qt module's C++ API requires linking against the module library, + either directly or through other dependencies. Several build tools have + dedicated support for this, including \l{CMake Documentation}{CMake} and + \l{qmake}. //! [using the c++ api] //! [using the qml api] diff --git a/doc/global/includes/standardpath/functiondocs.qdocinc b/doc/global/includes/standardpath/functiondocs.qdocinc index c0f4763b90..135aa25aa3 100644 --- a/doc/global/includes/standardpath/functiondocs.qdocinc +++ b/doc/global/includes/standardpath/functiondocs.qdocinc @@ -12,7 +12,7 @@ //! [findExecutable] Finds the executable named \a executableName in the specified - \a paths, or the system paths if paths is empty. + \a paths, or the system paths if \a paths is empty. On most operating systems the system path is determined by the \c PATH environment variable. The directories where to search for @@ -21,8 +21,8 @@ twice, once with paths set and once with paths empty. Symlinks are not resolved in order to preserve behavior for the case of executables whose behavior depends on the name they are - invoked with - . + invoked with. + \note On Windows, the usual executable extensions (from the PATHEXT environment variable) are automatically appended. For example, the findExecutable("foo") call finds \c foo.exe or \c foo.bat if @@ -31,8 +31,8 @@ Returns the absolute file path to the executable, or an empty string if not found. - If the given \n executableName is an absolute path pointing to - an executable its clean path is returned. + If the given \a executableName is an absolute path pointing to + an executable, its clean path is returned. //! [findExecutable] @@ -71,11 +71,13 @@ It affects the locations into which test programs might write files: \c GenericDataLocation, \c AppDataLocation, \c ConfigLocation, \c GenericConfigLocation, \c AppConfigLocation, + \c StateLocation, \c GenericStateLocation, \c GenericCacheLocation, and \c CacheLocation. Other locations are not affected. On Unix, \c XDG_DATA_HOME is set to \c{~/.qttest/share}, - \c XDG_CONFIG_HOME is set to \c{~/.qttest/config}, and + \c XDG_CONFIG_HOME is set to \c{~/.qttest/config}, + \c XDG_STATE_HOME is set \c{~/.qttest/state} and \c XDG_CACHE_HOME is set to \c{~/.qttest/cache}. On macOS, data goes to \c{~/.qttest/Application Support}, diff --git a/doc/global/macros-online.qdocconf b/doc/global/macros-online.qdocconf index bfc2f98a12..dafbabff4d 100644 --- a/doc/global/macros-online.qdocconf +++ b/doc/global/macros-online.qdocconf @@ -2,5 +2,11 @@ macro.youtube.HTML = "<div class=\"video\">\n<span class=\"vspan\"></span>\n" \ "<iframe src=\"https://www.youtube.com/embed/\1\"" \ "frameborder=\"0\" allowfullscreen>\n" \ "</iframe></div>\n" +macro.youtube.DocBook = "<db:mediaobject>\n" \ + "<db:videoobject>\n" \ + "<db:videodata fileref=\"\1\">\n" \ + "</db:videodata>\n" \ + "</db:videoobject>\n" \ + "</db:mediaobject>\n" include(htmltabs.qdocconf) diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 31cecc1b78..93c6fa0ab0 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -1,44 +1,96 @@ macro.aacute.HTML = "á" +macro.aacute.DocBook = "á" macro.Aring.HTML = "Å" +macro.Aring.DocBook = "Å" macro.aring.HTML = "å" +macro.aring.DocBook = "å" macro.Auml.HTML = "Ä" +macro.Auml.DocBook = "Ä" macro.author = "\\b{Author:}" macro.BR.HTML = "<br />" +macro.BR.DocBook = "" macro.copyright.HTML = "©" +macro.copyright.DocBook = "©" macro.eacute.HTML = "é" +macro.eacute.DocBook = "é" macro.gui = "\\b" macro.HR.HTML = "<hr />" +macro.HR.DocBook = "" macro.iacute.HTML = "í" +macro.iacute.DocBook = "í" macro.key = "\\b" macro.macos = "macOS" macro.menu = "\\b" macro.oslash.HTML = "ø" +macro.oslash.DocBook = "ø" macro.ouml.HTML = "ö" +macro.ouml.DocBook = "ö" macro.nothing = "\\dontdocument ()" macro.nullptr = "\\c{nullptr}" -macro.QA = "\\e{Qt Assistant}" -macro.QD = "\\e{Qt Designer}" -macro.QL = "\\e{Qt Linguist}" macro.Q_OBJECT = "Q_OBJECT" -macro.QQV = "\\e{Qt QML Viewer}" macro.QtVersion = "$QT_VERSION" macro.QtVer = "$QT_VER" macro.param = "\\e" macro.raisedaster.HTML = "<sup>*</sup>" -macro.raisedaster.DocBook = "\\sup{*}" +macro.raisedaster.DocBook = "<db:superscript>*</db:superscript>" macro.rarrow.HTML = "→" +macro.rarrow.DocBook = "→" macro.reg.HTML = "<sup>®</sup>" -macro.rego.DocBook = "\\sup{®}" +macro.reg.DocBook = "\\sup{®}" macro.return = "Returns" macro.starslash = "\\c{*/}" macro.begincomment = "\\c{/*}" macro.endcomment = "\\c{*/}" macro.uuml.HTML = "ü" +macro.uuml.DocBook = "ü" macro.mdash.HTML = "—" +macro.mdash.DocBook = "—" macro.pi.HTML = "Π" +macro.pi.DocBook = "Π" macro.beginqdoc.HTML = "/*!" +macro.beginqdoc.DocBook = "/*!" macro.endqdoc.HTML = "*/" +macro.endqdoc.DocBook = "*/" macro.borderedimage = "\\div {class=\"border\"} \\image \1\n\\enddiv" +macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1" + +# Macros for product names, sorted in alphabetic order + +macro.QA = "Qt Assistant" +macro.QB = "Qt Bridge" +macro.QBF = "Qt Bridge for Figma" +macro.QBPS = "Qt Bridge for Adobe Photoshop" +macro.QBSK = "Qt Bridge for Sketch" +macro.QBXD = "Qt Bridge for Adobe XD" +macro.QD = "Qt Widgets Designer" +macro.QDS = "Qt Design Studio" +macro.QDV = "Qt Design Viewer" +macro.QL = "Qt Linguist" +macro.QMCU = "Qt for MCUs" +macro.QMLLS = "QML Language Server" +macro.QMT = "Qt Maintenance Tool" +macro.QOI = "Qt Online Installer" +macro.QQV = "Qt QML Viewer" +macro.QtAA = "Qt for Android Automotive" +macro.QUL = "Qt Quick Ultralite" +macro.QtTAS = "Qt Tools for Android Studio" + +# The following macros are used for various Android docs. The purpose is to keep +# it as simple as updating these instead of updating multiple lines in scattered locations. +macro.AndroidAbis = "\\c{arm64-v8}, \\c{x86_64}, \\c{x86}, and \\c{armeabi-v7a}" +macro.NdkVer = "r26b" +macro.NdkFullVer = "26.1.10909125" +macro.NdkCompilerVer = "Clang 17.0.2" +macro.JdkVer = "17" +macro.AndroidMinApiVer = "26" +macro.AndroidMaxApiVer = "34" +macro.AndroidMinVer = "8.0" +macro.AndroidMaxVer = "14" +macro.AndroidPlatformVer = "34" +macro.AndroidBuildToolsVer = "34.0.0" +macro.GradleVer = "8.3" +macro.AGPVer = "7.4.1" +macro.AAOSVer = "10 to 13" macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">" @@ -46,6 +98,12 @@ macro.endfloat.HTML = "</div>" macro.clearfloat.HTML = "<br style=\"clear: both\" />" macro.emptyspan.HTML = "<span></span>" +macro.beginfloatleft.DocBook = "" +macro.beginfloatright.DocBook = "" +macro.endfloat.DocBook = "" +macro.clearfloat.DocBook = "" +macro.emptyspan.DocBook = "" + # Used like \brief, but replicates the sentence also as text. # Wrap the entire sentence with {}, for example: # \summary {Creates a build target.} @@ -57,16 +115,27 @@ macro.QtMajorVersion.match = "^(\\d+)\\." macro.QtMinorVersion.match = "\\d+\\.(\\d+)" # Embed YouTube content by video ID - Example: \youtube dQw4w9WgXcQ -# Also requires a <ID>.jpg thumbnail for offline docs. In .qdocconf, add: +# Also requires a <ID>.jpg thumbnail for offline docs. By default, qdoc doesn't copy the thumbnail +# along with the offline docs, you must specify it manually. In .qdocconf, to do it for all formats +# at once, add: # -# HTML.extraimages += images/dQw4w9WgXcQ.jpg -# qhp.ProjectName.extraFiles += images/dQw4w9WgXcQ.jpg +# {HTML.extraimages,qhp.QtDoc.extraFiles, DocBook.extraimages} += images/dQw4w9WgXcQ.jpg # macro.youtube.HTML = "<div class=\"video\">\n" \ "<a href=\"https://www.youtube.com/watch/?v=\1\">\n"\ "<img src=\"images/\1.jpg\"" \ "title=\"Click to play in a browser\" /></a>\n" \ "</div>\n" +macro.youtube.DocBook = "<db:mediaobject>\n" \ + "<db:videoobject>\n" \ + "<db:videodata fileref=\"\1\">\n" \ + "</db:videodata>\n" \ + "</db:videoobject>\n" \ + "<db:imageobject>\n" \ + "<db:imagedata fileref=\"images/\1.jpg\">\n" \ + "</db:imagedata>\n" \ + "</db:imageobject>\n" \ + "</db:mediaobject>\n" macro.excludefromcreator = "\\meta tag broken" @@ -85,3 +154,12 @@ macro.cmakevariableandroidonly = "\\note This variable is used only if targeting macro.versionlessCMakeCommandsNote = "If \\l{Versionless commands}{versionless commands} are disabled, use \\c{\1} instead. It supports the same set of arguments as this command." macro.cmakepropertywebassemblyonly = "\\note This property is used only if targeting the WebAssembly platform." + +macro.cmakepropertyiosonly = "\\note This property is used only if targeting iOS." +macro.cmakevariableiosonly = "\\note This variable is used only if targeting iOS." + +macro.qtpolicydeprecatedbehavior = "\\note The \\c{OLD} behavior of a policy is deprecated, and may be removed in the future." +#Appends the tech preview link to the brief sentence and adds to tech_preview +#group. +#Must be placed directly under a \brief command +macro.techpreview = "(Technical preview)\n\n\\meta status {Technical preview}\n\\ingroup tech_preview\n" diff --git a/doc/global/manifest-meta.qdocconf b/doc/global/manifest-meta.qdocconf index e9e273461d..863451681a 100644 --- a/doc/global/manifest-meta.qdocconf +++ b/doc/global/manifest-meta.qdocconf @@ -19,7 +19,7 @@ # manifestmeta.filters = highlighted sql global # # manifestmeta.highlighted.names = "QtGui/Analog Clock Window Example" \ -# "QtWidgets/Analog Clock Example" +# "QtWidgets/Analog Clock" # manifestmeta.highlighted.attributes = isHighlighted:true # # manifestmeta.sql.names = "QtSql/*" @@ -35,16 +35,14 @@ manifestmeta.highlighted.attributes = isHighlighted:true manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ "Qt3D/Qt 3D: Planets QML Example" \ "Qt3D/Qt 3D: Simple Custom Material QML Example" \ - "QtAndroidExtras/Qt Notifier" \ + "QtCore/Qt Android Notifier" \ "QtBluetooth/Bluetooth Low Energy Scanner Example" \ "QtBluetooth/Bluetooth Scanner Example" \ "QtBluetooth/QML Bluetooth Scanner Example" \ "QtCharts/*" \ - "QtConcurrent/QtConcurrent Progress Dialog Example" \ "QtDataVisualization/Audiolevels Example" \ "QtDataVisualization/Qt Quick 2 Scatter Example" \ "QtDataVisualization/Qt Quick 2 Surface Multiseries Example" \ - "QtGui/Analog Clock Window Example" \ "QtGui/OpenGL Window Example" \ "QtGui/Raster Window Example" \ "QtLinguist/Arrow Pad Example" \ @@ -53,17 +51,14 @@ manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ "QtLocation/Places Map (QML)" \ "QtLocation/Plane Spotter (QML)" \ "QtMultimedia/AudioEngine Example" \ - "QtMultimedia/Camera Example" \ "QtMultimedia/QML Camera Example" \ "QtMultimedia/QML Video Example" \ "QtMultimedia/QML Video Shader Effects Example" \ "QtNFC/Annotated URL Example" \ "QtNFC/QML Poster Example" \ - "QtOpenGL/2D Painting Example" \ "QtOpenGL/Hello GLES3 Example" \ - "QtOpenGL/Textures Example" \ - "QtPositioning/SatelliteInfo (C++/QML)" \ - "QtPositioning/Weather Info (C++/QML)" \ + "QtPositioning/Satellite Info" \ + "QtPositioning/Weather Info" \ "QtPurchasing/Qt Purchasing Examples - QtHangman" \ "QtQML/Extending QML - Attached Properties Example" \ "QtQML/Extending QML - Grouped Properties Example" \ @@ -71,13 +66,33 @@ manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ "QtQML/Extending QML - Signal Support Example" \ "QtQML/Qt Quick Examples - XMLHttpRequest" \ "QtQml/Qt Quick Examples - XMLHttpRequest" \ - "QtQuick/*" \ - "QtQuickControls/*" \ - "QtQuickControls1/Qt Quick Controls 1 - Calendar Example" \ - "QtQuickControls1/Qt Quick Controls 1 - Gallery" \ - "QtQuickControls1/Qt Quick Controls 1 - Styles Example" \ - "QtQuickControls1/Qt Quick Controls 1 - Table View Example" \ - "QtQuickControls1/Qt Quick Controls 1 - Touch Gallery" \ + "QtQuick/C++ Extensions*" \ + "QtQuick/Models and Views*" \ + "QtQuick/QQuickRenderControl OpenGL Example" \ + "QtQuick/QQuickWidget - QQuickView Comparison Example" \ + "QtQuick/QML*" \ + "QtQuick/Qt Quick*" \ + "QtQuick/Scene Graph - Custom Geometry" \ + "QtQuick/Scene Graph - Custom Material" \ + "QtQuick/Scene Graph - Graph" \ + "QtQuick/Scene Graph - OpenGL Under QML" \ + "QtQuick/Scene Graph - Painted Item" \ + "QtQuick/Scene Graph - Rendering FBOs" \ + "QtQuick/Scene Graph - Two Texture Providers" \ + "QtQuick/Scene Graph - Vulkan Under QML" \ + "QtQuick/Scene Graph - Vulkan Texture Import" \ + "QtQuick/Threaded ListModel Example" \ + "QtQuick/TabWidget Example" \ + "QtQuick/UI Components*" \ + "QtQuickControls/Qt Quick Controls - Attached Style Properties Example" \ + "QtQuickControls/Qt Quick Controls - Chat Tutorial" \ + "QtQuickControls/Qt Quick Controls - Contact List" \ + "QtQuickControls/Qt Quick Controls - Event Calendar" \ + "QtQuickControls/Qt Quick Controls - Flat Style" \ + "QtQuickControls/Qt Quick Controls - Gallery" \ + "QtQuickControls/Qt Quick Controls - Imagine Style Example: Automotive" \ + "QtQuickControls/Qt Quick Controls - Text Editor" \ + "QtQuickControls/Qt Quick Controls - Wearable Demo" \ "QtQuickDialogs/*" \ "QtQuickExtras/*" \ "QtSCXML/Qt SCXML Calculator QML Example" \ @@ -87,57 +102,15 @@ manifestmeta.android.names = "Qt3D/Qt 3D: Basic Shapes C++ Example" \ "QtSQL/Master Detail Example" \ "QtSVG/Text Object Example" \ "QtUiTools/Text Finder Example" \ - "QtWebView/Qt WebView Examples - Minibrowser" \ - "QtWidgets/Address Book Example" \ - "QtWidgets/Affine Transformations" \ - "QtWidgets/Analog Clock Example" \ - "QtWidgets/Animated Tiles Example" \ - "QtWidgets/Application Chooser Example" \ - "QtWidgets/Basic Layouts Example" \ - "QtWidgets/Border Layout Example" \ - "QtWidgets/Code Editor Example" \ - "QtWidgets/Colliding Mice Example" \ - "QtWidgets/Concentric Circles Example" \ - "QtWidgets/Digital Clock Example" \ - "QtWidgets/Dynamic Layouts Example" \ - "QtWidgets/Easing Curves Example" \ - "QtWidgets/Editable Tree Model Example" \ - "QtWidgets/Elided Label Example" \ - "QtWidgets/Fade Message Effect Example" \ - "QtWidgets/Flow Layout Example" \ - "QtWidgets/Font Sampler Example" \ - "QtWidgets/Frozen Column Example" \ - "QtWidgets/Gradients" \ - "QtWidgets/Group Box Example" \ - "QtWidgets/Image Composition Example" \ - "QtWidgets/Line Edits Example" \ - "QtWidgets/Mouse Button Tester" \ - "QtWidgets/Move Blocks Example" \ - "QtWidgets/Painter Paths Example" \ - "QtWidgets/Painter Paths Example" \ - "QtWidgets/Path Stroking" \ - "QtWidgets/Pixelator Example" \ - "QtWidgets/Recent Files Example" \ - "QtWidgets/SDI Example" \ - "QtWidgets/Scribble Example" \ - "QtWidgets/Simple Tree Model Example" \ - "QtWidgets/Sliders Example" \ - "QtWidgets/Spreadsheet" \ - "QtWidgets/Touch Dials Example" \ - "QtWidgets/Transformations Example" \ - "QtWidgets/Undo Framework" \ - "QtWidgets/Vector Deformation" \ - "QtWidgets/Wiggly Example" + "QtWebView/Qt WebView Examples - Minibrowser" manifestmeta.android.tags = android manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtCore/Mandelbrot Example" \ - "QtCore/Queued Custom Type Example" \ - "QtGui/Analog Clock Window Example" \ + "QtCore/Queued Custom Type" \ "QtGui/OpenGL Window Example" \ "QtGui/Raster Window Example" \ - "QtNetwork/Loopback Example" \ "QtNetwork/Network Chat Example" \ "QtNetwork/Torrent Example" \ "QtOpenGL/2D Painting Example" \ @@ -147,7 +120,6 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Easing Curves Example" \ "QtWidgets/Move Blocks Example" \ "QtWidgets/States Example" \ - "QtWidgets/Class Wizard Example" \ "QtWidgets/Find Files Example" \ "QtWidgets/License Wizard Example" \ "QtWidgets/Standard Dialogs Example" \ @@ -158,7 +130,6 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Blur Picker Effect Example" \ "QtWidgets/Fade Message Effect Example" \ "QtWidgets/Lighting Effect Example" \ - "QtWidgets/Anchor Layout Example" \ "QtWidgets/Basic Graphics Layouts Example" \ "QtWidgets/40000 Chips" \ "QtWidgets/Colliding Mice Example" \ @@ -167,8 +138,7 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Embedded Dialogs" \ "QtWidgets/Graphics View Flow Layout Example" \ "QtWidgets/Simple Anchor Layout Example" \ - "QtWidgets/Weather Anchor Layout Example" \ - "QtWidgets/Address Book Example" \ + "QtWidgets/Address Book" \ "QtWidgets/Basic Sort/Filter Model Example" \ "QtWidgets/Chart Example" \ "QtWidgets/Custom Sort/Filter Model Example" \ @@ -182,7 +152,6 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Border Layout Example" \ "QtWidgets/Flow Layout Example" \ "QtWidgets/Basic Drawing Example" \ - "QtWidgets/Concentric Circles Example" \ "QtWidgets/Font Sampler Example" \ "QtWidgets/Gradients" \ "QtWidgets/Image Composition Example" \ @@ -195,7 +164,7 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Completer Example" \ "QtWidgets/Custom Completer Example" \ "QtWidgets/Undo Framework" \ - "QtWidgets/Analog Clock Example" \ + "QtWidgets/Analog Clock" \ "QtWidgets/Calculator Example" \ "QtWidgets/Calendar Widget Example" \ "QtWidgets/Character Map Example" \ @@ -208,7 +177,6 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtWidgets/Sliders Example" \ "QtWidgets/Validators Example" \ "QtWidgets/Window Flags Example" \ - "QtWidgets/Wiggly Example" \ "QtQuick/Qt Quick Examples - Animation" \ "QtQuick/Qt Quick Examples - Canvas" \ "QtQuick/Qt Quick Examples - Drag and Drop" \ @@ -216,12 +184,15 @@ manifestmeta.ios.names = "QtCore/Contiguous Cache Example" \ "QtQuick/Qt Quick Examples - MouseArea" \ "QtQuick/Qt Quick Examples - Positioners" \ "QtQuick/Qt Quick Examples - Right to Left" \ + "QtQuick/Scene Graph - Metal Texture Import" \ + "QtQuick/Scene Graph - Metal Under QML" \ "QtQuick/Scene Graph - OpenGL Under QML" \ "QtQuick/Qt Quick Examples - Shader Effects" \ "QtQuick/Qt Quick Examples - Text" \ "QtQuick/Qt Quick Examples - Touch Interaction" \ "QtQuick/Qt Quick Examples - Views" \ - "QtQuick/Qt Quick Examples - Window and Screen" + "QtQuick/Qt Quick Examples - Window and Screen" \ + "QtQuickControls/Qt Quick Controls - To Do List" manifestmeta.ios.tags = ios @@ -229,13 +200,10 @@ manifestmeta.ios.tags = ios manifestmeta.thumbnail.attributes = "imageUrl:qthelp\://org.qt-project.qtdoc.$QT_VERSION_TAG/qtdoc/images/qt-codesample.png" manifestmeta.thumbnail.names = "QtCore/Contiguous Cache Example" \ - "QtCore/Custom Type Example" \ - "QtCore/JSON Save Game Example" \ - "QtCore/Semaphores Example" \ - "QtCore/Wait Conditions Example" \ - "QtConcurrent/Map Example" \ - "QtConcurrent/QtConcurrent Word Count Example" \ - "QtConcurrent/Run Function Example" \ + "QtCore/Saving and Loading a Game" \ + "QtCore/Producer and Consumer using Semaphores" \ + "QtCore/Producer and Consumer using Wait Conditions" \ + "QtConcurrent/Word Count" \ "QtGui/Raster Window Example" \ "QtNetwork/Network Download*" \ "QtWidgets/Dynamic Layouts Example" \ diff --git a/doc/global/qt-cpp-defines.qdocconf b/doc/global/qt-cpp-defines.qdocconf index 0e841e80c9..2f80ca3a68 100644 --- a/doc/global/qt-cpp-defines.qdocconf +++ b/doc/global/qt-cpp-defines.qdocconf @@ -18,3 +18,17 @@ excludefiles += \ "*_udev.cpp" \ "*_vxworks.cpp" \ "*_darwin.cpp" + +# Convenience macros for specifying C++ type ordering in \class documentation +# +# Usage: \stronglyordered +# \stronglyorderedwith {Type1 [Type2 .. TypeN]} + +macro.stronglyordered = "\\compares strong" +macro.stronglyorderedwith = "\\compareswith strong \1\n\\endcompareswith" +macro.weaklyordered = "\\compares weak" +macro.weaklyorderedwith = "\\compareswith weak \1\n\\endcompareswith" +macro.partiallyordered = "\\compares partial" +macro.partiallyorderedwith = "\\compareswith partial \1\n\\endcompareswith" +macro.equalitycomparable = "\\compares equality" +macro.equalitycomparablewith = "\\compareswith equality \1\n\\endcompareswith" diff --git a/doc/global/qt-html-templates-offline.qdocconf b/doc/global/qt-html-templates-offline.qdocconf index 39f49fd3da..cbd896f655 100644 --- a/doc/global/qt-html-templates-offline.qdocconf +++ b/doc/global/qt-html-templates-offline.qdocconf @@ -8,7 +8,8 @@ defines += offlinedocs #uncomment if navigation bar is not wanted #HTML.nonavigationbar = "true" -HTML.stylesheets = template/style/offline.css +HTML.stylesheets = template/style/offline.css \ + template/style/offline-dark.css HTML.extraimages += template/images/ico_out.png \ template/images/ico_note.png \ template/images/ico_note_attention.png \ @@ -22,6 +23,17 @@ sourcedirs += includes #specify which files in the output directory should be packed into the qch file. qhp.extraFiles += style/offline.css \ + style/offline-dark.css \ + images/ico_out.png \ + images/ico_note.png \ + images/ico_note_attention.png \ + images/btn_prev.png \ + images/btn_next.png \ + images/bullet_dn.png \ + images/bullet_sq.png \ + images/bgrContent.png + +DocBook.extraimages += \ images/ico_out.png \ images/ico_note.png \ images/ico_note_attention.png \ diff --git a/doc/global/qt-module-defaults-online.qdocconf b/doc/global/qt-module-defaults-online.qdocconf index 6acf3a47d8..4942c2639d 100644 --- a/doc/global/qt-module-defaults-online.qdocconf +++ b/doc/global/qt-module-defaults-online.qdocconf @@ -5,7 +5,7 @@ HTML.footer = \ " </div>\n" \ " <p class=\"copy-notice\">\n" \ - " <acronym title=\"Copyright\">©</acronym> 2022 The Qt Company Ltd.\n" \ + " <abbr title=\"Copyright\">©</abbr> 2024 The Qt Company Ltd.\n" \ " Documentation contributions included herein are the copyrights of\n" \ " their respective owners. " \ " The documentation provided herein is licensed under the terms of the" \ @@ -31,4 +31,4 @@ include(config.qdocconf) # single-directory output mode HTML.nosubdirs = "true" -HTML.outputsubdir = "html" +HTML.outputsubdir = "../html" diff --git a/doc/global/snippets/code/doc_src_port_from_qregexp.cpp b/doc/global/snippets/code/doc_src_port_from_qregexp.cpp index 58e79e5ac1..735425d086 100644 --- a/doc/global/snippets/code/doc_src_port_from_qregexp.cpp +++ b/doc/global/snippets/code/doc_src_port_from_qregexp.cpp @@ -1,7 +1,7 @@ // Copyright (C) 2022 Giuseppe D'Angelo <dangelog@gmail.com>. // Copyright (C) 2022 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Giuseppe D'Angelo <giuseppe.dangelo@kdab.com> // Copyright (C) 2022 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause //! [0] QString p("a .*|pattern"); diff --git a/doc/global/template/style/offline-dark.css b/doc/global/template/style/offline-dark.css new file mode 100644 index 0000000000..1410a6091a --- /dev/null +++ b/doc/global/template/style/offline-dark.css @@ -0,0 +1,778 @@ +body { + font: normal 400 14px/1.2 Arial; + margin-top: 50px; + font-family: Arial, Helvetica; + text-align: left; + margin-left: 5px; + margin-right: 5px; + background-color: #2E2F30; + color: #d0d0d0 +} + +p { + line-height: 20px +} + +img { + margin-left: 0px; + max-width: 800px; + height: auto; + filter: brightness(85%); +} + +.content .border img { + box-shadow:3px 3px 8px 3px rgba(200,200,200,0.5) +} + +.content .border .player { + box-shadow:3px 3px 8px 3px rgba(200,200,200,0.5) +} + +.content .indexboxcont li { + font: normal bold 13px/1 Verdana + } + +.content .normallist li { + font: normal 13px/1 Verdana + } + +.descr { + margin-top: 35px; + margin-bottom: 45px; + margin-left: 5px; + text-align: left; + vertical-align: top; +} + +.name { + max-width: 75%; + font-weight: 100; +} + +tt { + text-align: left +} + +/* +----------- +links +----------- +*/ + +a:link { + color: #9a9ef9; + text-decoration: none; + text-align: left; +} + +a.qa-mark:target:before { + content: "***"; + color: #ff0000; +} + +a:hover { + color: #9a9ef9; + text-decoration:underline; + text-align: left; +} + +a:visited { + color: #9a9ef9; + text-align: left; +} + +a:visited:hover { + color: #9a9ef9; + text-align: left; +} + +/* +----------- +offline viewing: HTML links display an icon +----------- +*/ + +a[href*="http://"]::before, +a[href*="ftp://"]::before, +a[href*="https://"]::before { + content: url(../images/ico_out.png); + padding-right: 5px; +} + +.video a { + background: none; +} + +.flags { + text-decoration: none; + text-height: 24px; +} + +.flags:target { + background-color: #FFFFD6; +} + +/* +------------------------------- +NOTE styles +------------------------------- +*/ +.admonition { + padding: 5px 0 5px 40px; + border: #404142 1px solid; +} + +.admonition.note, .admonition.important { + background: #353637 3px 6px no-repeat url(../images/ico_note.png); +} + +.admonition.warning { + background: #353637 3px 6px no-repeat url(../images/ico_note_attention.png); +} +/* +------------------------------- +Top navigation +------------------------------- +*/ + +.qtref { + display: block; + position: relative; + height: 15px; + z-index: 1; + font-size: 11px; + padding-right: 10px; + float: right; +} + +.naviNextPrevious { + clear: both; + display: block; + position: relative; + text-align: right; + top: -30px; + float: right; + height: 20px; + z-index: 1; + padding-right: 10px; + padding-top: 2px; + vertical-align: top; + margin: 0px; +} + +.naviNextPrevious > a:first-child { + background-image: url(../images/btn_prev.png); + background-repeat: no-repeat; + background-position: left; + padding-left: 20px; + height: 20px; + padding-left: 20px; + } + +.naviNextPrevious > a:last-child { + background-image: url(../images/btn_next.png); + background-repeat: no-repeat; + background-position: right; + padding-right: 20px; + height: 20px; + margin-left: 30px; + } + +.naviSeparator { display: none } +/* +----------- +footer and license +----------- +*/ + +.footer { + text-align: left; + padding-top: 45px; + padding-left: 5px; + margin-top: 45px; + margin-bottom: 45px; + font-size: 10px; + border-top: 1px solid #404142; +} + +.footer p { + line-height: 14px; + font-size: 11px; + padding: 0; + margin: 0; +} + +.footer a[href*="http://"], a[href*="ftp://"], a[href*="https://"] { + font-weight: bold; +} + +.footerNavi { + width: auto; + text-align: right; + margin-top: 50px; + z-index: 1; +} + +.navigationbar { + display: block; + position: relative; + border-top: 1px solid #404142; + border-bottom: 1px solid #404142; + background-color: #353637; + z-index: 1; + height: 20px; + padding-left: 7px; + margin: 0px; + padding-top: 2px; + margin-left: -5px; + margin-right: -5px; +} + +.navigationbar .first { + background: url(../images/home.png); + background-position: left; + background-repeat: no-repeat; + padding-left: 20px; + } + +.navigationbar ul { + margin: 0px; + padding: 0px; + } + + .navigationbar ul li { + list-style-type: none; + padding-top: 2px; + padding-left: 4px; + margin: 0; + height: 20px; + } + +.navigationbar li { + float: left + } + + .navigationbar li a, .navigationbar td a { + display: block; + text-decoration: none; + background: url(../images/arrow_bc.png); + background-repeat: no-repeat; + background-position: right; + padding-right: 17px; + } + +table.buildversion { + float: right; + margin-top: -18px !important; +} + +.navigationbar table { + border-radius: 0; + border: 0 none; + background-color: #F2F2F2; + margin: 0; +} + +.navigationbar table td { + padding: 0; + border: 0 none; +} + +#buildversion { + font-style: italic; + float: right; + margin-right: 5px; +} + +#buildversion a { + background: none; +} + +/* + +/* table of content +no display +*/ + +/* +----------- +headers +----------- +*/ + +@media screen { + .title { + color: #d0d0d0; + font-size: 20px; + font-weight: normal; + left: 0; + padding-bottom: 15px; + padding-left: 10px; + padding-top: 15px; + position: absolute; + right: 0; + top: 0; + background-color: #2E2F30; + border-bottom: 1px #404142 solid; + font-weight: bold; + margin-left: 0px; + margin-right: 0px; + } + .subtitle, .small-subtitle { + display: block; + clear: left; + } +} + +h1 { + margin: 0 +} + +h2, p.h2 { + font: 500 16px/1.2 Arial; + font-weight: 100; + background-color: #353637; + padding: 4px; + margin-bottom: 15px; + margin-top: 30px; + border-top: #404142 1px solid; + border-bottom: #404142 1px solid; + max-width: 99%; +} + +h2:target { + background-color: #F2F3D4; +} + +h3 { + font: 500 14px/1.2 Arial; + font-weight: 100; + text-decoration: underline; + margin-bottom: 15px; + margin-top: 30px; +} + +h3.fn, span.fn { + border-width: 1px; + border-style: solid; + border-color: #404142; + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background-color: #353637; + word-spacing: 3px; + padding: 5px 5px; + text-decoration: none; + font-weight: bold; + max-width: 75%; + font-size: 14px; + margin: 0px; + margin-top: 30px; +} +.fngroup h3.fngroupitem { + margin-bottom: 5px; +} + +h3.fn code, +h3.flags code, +td.tblQmlFuncNode > p > code, +td.tblQmlPropNode > p > code { + float: right; +} + +code.extra.summary { + font-size: 12px; +} + +h3.fn:target { + background-color: #F6F6D6; +} + +.name { + color: #d0d0d0 +} + +.type { + color: #a4a6a8 +} + +/* +----------------- +table styles +----------------- +*/ + +.table img { + border: none; + margin-left: 0px; + -moz-box-shadow: 0px 0px 0px #2E2F30; + -webkit-box-shadow: 0px 0px 0px #2E2F30; + box-shadow: 0px 0px 0px #2E2F30; +} + +/* table with border alternative colors*/ + +table, pre, .LegaleseLeft { + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background-color: #353637; + border: 1px solid #404142; + border-collapse: separate; + margin-bottom: 25px; + margin-left: 15px; + font-size: 12px; + line-height: 1.2; +} + + table tr.even { + background-color: #2E2F30; + color: #a4a6a8; + } + + table tr.odd { + background-color: #353637; + color: #a4a6a8; + } + + table tr:target { + background-color: #F6F6D6; + } + + table thead { + text-align: left; + padding-left: 20px; + background-color: #2E2F30; + border-left: none; + border-right: none; + } + + table thead th { + padding-top: 5px; + padding-left: 10px; + padding-bottom: 5px; + border-bottom: 2px solid #404142; + padding-right: 10px; + } + + table th { + text-align: left; + padding-left: 20px; + } + + table td { + padding: 3px 15px 3px 20px; + border-bottom: #404142 dotted 1px; + } + + table p { + margin: 0px + } + +.LegaleseLeft { + font-family: monospace; + white-space: pre-wrap; +} +/* table bodless & white*/ + +.borderless { + border-radius: 0px 0px 0px 0px; + background-color: #2E2F30; + border: 1px solid #2E2F30; +} + +.borderless tr { + background-color: #2E2F30; + color: #d0d0d0; + } + +.borderless td { + border: none; + border-bottom: #2E2F30 dotted 1px; + } + +/* +----------- +List +----------- +*/ + +ul { + margin-top: 10px; +} + +li { + margin-bottom: 10px; + padding-left: 8px; + list-style: outside; + text-align: left; +} + + ul > li { + list-style-type: square; + } + +ol { + margin: 10px; + padding: 0; +} + +ol.A > li { + list-style-type: upper-alpha; +} + +ol.a > li{ + list-style-type: lower-alpha; +} + +ol > li { + margin-left: 30px; + padding-left: 8px; + list-style-type: decimal; +} + +ol.A > li { + list-style-type: upper-alpha; +} + +ol.a > li { + list-style-type: lower-alpha; +} + +ol.i > li { + list-style-type: lower-roman; +} + +ol.I > li { + list-style-type: upper-roman; +} + +.centerAlign { + text-align: left +} + +.cpp, .LegaleseLeft { + display: block; + margin: 10px; + overflow: auto; + padding: 20px 20px 20px 20px; +} + +.js { + display: block; + margin: 10px; + overflow: auto; + padding: 20px 20px 20px 20px; +} + +.memItemLeft { + padding-right: 3px +} + +.memItemRight { + padding: 3px 15px 3px 0 +} + +.qml { + display: block; + margin: 10px; + overflow: auto; + padding: 20px 20px 20px 20px; +} + +.qmlextra { + padding-left: 5px; + float: right; +} + +.rightAlign { + padding: 3px 5px 3px 10px; + text-align: right; +} + +.qmldoc { + margin-left: 15px +} + +.flowList { + padding: 25px +} +.flowList dd { + display: inline-block; + margin-left: 10px; + width: 255px; + line-height: 1.15em; + overflow-x: hidden; + text-overflow: ellipsis +} +.alphaChar { + font-size: 2em; + position: relative +} +/* +----------- +Content table +----------- +*/ + +@media screen { + .toc { + float: right; + clear: right; + vertical-align: top; + -moz-border-radius: 7px 7px 7px 7px; + -webkit-border-radius: 7px 7px 7px 7px; + border-radius: 7px 7px 7px 7px; + background: #353637; + background-position: top; + background-repeat: repeat-x; + border: 1px solid #404142; + padding-left: 5px; + padding-bottom: 10px; + height: auto; + width: 200px; + text-align: left; + margin-left: 20px; + margin-top: 5px; + } +} + + +.toc h3 { + text-decoration: none +} + +.toc h3 { + font: 500 14px/1.2 Arial; + font-weight: 100; + padding: 0px; + margin: 0px; + padding-top: 5px; + padding-left: 5px; +} + +.toc ul { + padding-left: 10px; + padding-right: 5px; +} + +.toc ul li { + margin-left: 15px; + marker-offset: 0px; + margin-bottom: 8px; + padding-left: 0px; + } + +.toc .level1 { + border: none +} + +.toc .level2 { + border: none; + margin-left: 25px; +} + +.level3 { + border: none; + margin-left: 30px; +} + +.clearfix { + clear: both +} + +/* +----------- +Landing page +----------- +*/ + +.col-group { + white-space: nowrap; + vertical-align: top; +} + + +.landing h2 { + background-color: transparent; + border: none; + margin-bottom: 0px; + font-size: 18px; +} + +.landing a, .landing li { + font-size: 13px; + font-weight: bold !important; +} + +.col-1 { + display: inline-block; + white-space: normal; + width: 70%; + height: 100%; + float: left; +} + +.col-2 { + display: inline-block; + white-space: normal; + width: 20%; + margin-left: 5%; + position: relative; + top: -20px; +} + +.col-1 h1 { + margin: 20px 0 0 0; + } + +.col-1 h2 { + font-size: 18px; + font-weight: bold !important; +} + +.landingicons { + display: inline-block; + width: 100%; +} + +.icons1of3 { + display: inline-block; + width: 33.3333%; + float: left; +} + +.icons1of3 h2, .doc-column h2 { + font-size: 15px; + margin: 0px; + padding: 0px; +} + +div.multi-column { + position: relative; +} + +div.multi-column div { + display: -moz-inline-box; + display: inline-block; + vertical-align: top; + margin-top: 1em; + margin-right: 4em; + width: 24em; +} + +.mainContent .video { + width:40%; + max-width:640px; + margin: 15px 0 0 15px; + position:relative; + display:table +} + +.mainContent .video iframe { + width:100%; + height:100%; + position:absolute; + top:0; + left:0 +} diff --git a/doc/global/template/style/offline.css b/doc/global/template/style/offline.css index 9f0cc8cd2e..6426109a49 100644 --- a/doc/global/template/style/offline.css +++ b/doc/global/template/style/offline.css @@ -369,9 +369,18 @@ h3.fn, span.fn { .fngroup h3.fngroupitem { margin-bottom: 5px; } -h3.fn code { + +h3.fn code, +h3.flags code, +td.tblQmlFuncNode > p > code, +td.tblQmlPropNode > p > code { float: right; } + +code.extra.summary { + font-size: 12px; +} + h3.fn:target { background-color: #F6F6D6; } @@ -574,6 +583,20 @@ ol.I > li { padding: 3px 15px 3px 0 } +span.status.technical-preview { + display: inline-block; + position: relative; + background: center/contain no-repeat url(tech_preview.svg); + width: 26px; + height: 23px; +} + +td.memItemRight span.status { + margin-top: -10px; + right: -10px; + top: 6px; +} + .qml { display: block; margin: 10px; diff --git a/doc/global/template/style/online.css b/doc/global/template/style/online.css index 23d387430e..d7c0187409 100644 --- a/doc/global/template/style/online.css +++ b/doc/global/template/style/online.css @@ -505,6 +505,18 @@ h1,h2,h3,h4,h5,h6 { font-size:150%; margin-bottom: 1em } +span.status.technical-preview { + display:inline-block; + position:relative; + background:center/contain no-repeat url(tech_preview.svg); + width:26px; + height:23px +} +td.memItemRight span.status { + margin-top:-10px; + right:-10px; + top:6px +} article,aside,details,figcaption,figure,footer,header,hgroup,menu,nav,section { display:block } @@ -1097,12 +1109,18 @@ span.wrap:active { code,.codelike { font-family:"Droid Sans Mono" } -h3.fn code { - font-size:0.75em; +h3.fn code, +h3.flags code, +td.tblQmlFuncNode > p > code, +td.tblQmlPropNode > p > code { + font-size:0.6em; float:right; background-color:#eee; padding:3px; - margin: 3px 0 0 20px + margin-left:20px +} +code.extra.summary { + font-size:0.75em; } pre:hover>.copy_text { display:inline-block; @@ -1569,3 +1587,9 @@ a.plink { a.plink::before { content:'\00B6' } + +/* Add margin for all anchor tags in a translated page */ +html.translated-ltr .mainContent p a, +html.translated-rtl .mainContent p a { + margin:0 2px 0 2px; +} diff --git a/doc/global/template/style/tech_preview.svg b/doc/global/template/style/tech_preview.svg new file mode 100644 index 0000000000..54ce08ddbb --- /dev/null +++ b/doc/global/template/style/tech_preview.svg @@ -0,0 +1 @@ +<svg xmlns="http://www.w3.org/2000/svg" width="49" height="43" viewBox="0 0 13 11" stroke="#09102b"><path d="M12.82 11.125L.155 11.121 6.491.155z" opacity=".999" fill="#ffe353" stroke-linejoin="round" stroke-width=".31"/><path d="M4.914 7.071L3.521 8.302l1.287 1.084m1.144.027l1.394-1.231-1.287-1.084m-.283-.539l-.788 2.974" fill="none" stroke-linecap="round" stroke-width=".151"/><path d="M7.287 9.358l-.013.259 1.695.025-.021-.297-1.662.013zm.706.017L7.989 5.7l.367-.004.017 3.658m.33-3.512l-.238.008.004.255.238.033-.004-.297zm-.221.05l-3.199.008.004.238 3.165-.021.029-.226zm-2.965.255l.025.447.28-.15.23.163-.267.313m-.23-.322l-.242-.046-.084.163.288.226" fill="#41cd52" stroke-width=".151"/></svg> diff --git a/doc/global/warninglimit.qdocconf b/doc/global/warninglimit.qdocconf new file mode 100644 index 0000000000..661240820a --- /dev/null +++ b/doc/global/warninglimit.qdocconf @@ -0,0 +1,9 @@ +# Fail the documentation test build if QDoc warnings exceed the limit. +# +# Submodule documentation projects can increase this base limit to +# account for known warnings, for example: +# +# qtcore.qdocconf: +# warninglimit += 1 + +warninglimit = 10 diff --git a/doc/src/images/analogclock-example.png b/doc/src/images/analogclock-example.png Binary files differindex 2319c2891b..3b6d5ec809 100644 --- a/doc/src/images/analogclock-example.png +++ b/doc/src/images/analogclock-example.png diff --git a/doc/src/images/application-menus.png b/doc/src/images/application-menus.png Binary files differdeleted file mode 100644 index 44ac9ca75f..0000000000 --- a/doc/src/images/application-menus.png +++ /dev/null diff --git a/doc/src/images/application.png b/doc/src/images/application.png Binary files differdeleted file mode 100644 index b5fd4597dc..0000000000 --- a/doc/src/images/application.png +++ /dev/null diff --git a/doc/src/images/bearermonitor-example.png b/doc/src/images/bearermonitor-example.png Binary files differdeleted file mode 100644 index 1b8a9c3834..0000000000 --- a/doc/src/images/bearermonitor-example.png +++ /dev/null diff --git a/doc/src/images/classwizard-flow.png b/doc/src/images/classwizard-flow.png Binary files differdeleted file mode 100644 index ad9446c430..0000000000 --- a/doc/src/images/classwizard-flow.png +++ /dev/null diff --git a/doc/src/images/classwizard.png b/doc/src/images/classwizard.png Binary files differdeleted file mode 100644 index ea740bd213..0000000000 --- a/doc/src/images/classwizard.png +++ /dev/null diff --git a/doc/src/images/codeeditor-example.png b/doc/src/images/codeeditor-example.png Binary files differdeleted file mode 100644 index 32cf94779f..0000000000 --- a/doc/src/images/codeeditor-example.png +++ /dev/null diff --git a/doc/src/images/coloreditorfactoryimage.png b/doc/src/images/coloreditorfactoryimage.png Binary files differdeleted file mode 100644 index cd839a6db6..0000000000 --- a/doc/src/images/coloreditorfactoryimage.png +++ /dev/null diff --git a/doc/src/images/concentriccircles-example.png b/doc/src/images/concentriccircles-example.png Binary files differdeleted file mode 100644 index fd308b5642..0000000000 --- a/doc/src/images/concentriccircles-example.png +++ /dev/null diff --git a/doc/src/images/elidedlabel-example.png b/doc/src/images/elidedlabel-example.png Binary files differdeleted file mode 100644 index 741d2896e7..0000000000 --- a/doc/src/images/elidedlabel-example.png +++ /dev/null diff --git a/doc/src/images/extension-example.png b/doc/src/images/extension-example.png Binary files differdeleted file mode 100644 index 18fab52825..0000000000 --- a/doc/src/images/extension-example.png +++ /dev/null diff --git a/doc/src/images/extension_more.png b/doc/src/images/extension_more.png Binary files differdeleted file mode 100644 index 407af27cab..0000000000 --- a/doc/src/images/extension_more.png +++ /dev/null diff --git a/doc/src/images/findfiles-example.png b/doc/src/images/findfiles-example.png Binary files differdeleted file mode 100644 index cf3885c015..0000000000 --- a/doc/src/images/findfiles-example.png +++ /dev/null diff --git a/doc/src/images/groupbox-example.png b/doc/src/images/groupbox-example.png Binary files differdeleted file mode 100644 index 56f95fa8b1..0000000000 --- a/doc/src/images/groupbox-example.png +++ /dev/null diff --git a/doc/src/images/i18n-example.png b/doc/src/images/i18n-example.png Binary files differdeleted file mode 100644 index 20c46c9e63..0000000000 --- a/doc/src/images/i18n-example.png +++ /dev/null diff --git a/doc/src/images/screenshot-example.png b/doc/src/images/screenshot-example.png Binary files differindex 86894867c3..6bbad985f3 100644 --- a/doc/src/images/screenshot-example.png +++ b/doc/src/images/screenshot-example.png diff --git a/doc/src/images/sdi-example.png b/doc/src/images/sdi-example.png Binary files differdeleted file mode 100644 index 8cd7aa0128..0000000000 --- a/doc/src/images/sdi-example.png +++ /dev/null diff --git a/doc/src/images/shapedclock-dragging.png b/doc/src/images/shapedclock-dragging.png Binary files differindex 1b25afbcf0..239dcacea5 100644 --- a/doc/src/images/shapedclock-dragging.png +++ b/doc/src/images/shapedclock-dragging.png diff --git a/doc/src/images/shapedclock-example.png b/doc/src/images/shapedclock-example.png Binary files differindex 31ceeca7f9..2ae8e19085 100644 --- a/doc/src/images/shapedclock-example.png +++ b/doc/src/images/shapedclock-example.png diff --git a/doc/src/images/shortcuteditor-example.png b/doc/src/images/shortcuteditor-example.png Binary files differnew file mode 100644 index 0000000000..1fe9a77cdd --- /dev/null +++ b/doc/src/images/shortcuteditor-example.png diff --git a/doc/src/images/sliders-example.png b/doc/src/images/sliders-example.png Binary files differindex d2a9c4804d..532f745dfa 100644 --- a/doc/src/images/sliders-example.png +++ b/doc/src/images/sliders-example.png diff --git a/doc/src/images/tooltips-example.png b/doc/src/images/tooltips-example.png Binary files differdeleted file mode 100644 index f2236b43de..0000000000 --- a/doc/src/images/tooltips-example.png +++ /dev/null diff --git a/doc/src/images/wiggly-example.png b/doc/src/images/wiggly-example.png Binary files differdeleted file mode 100644 index 5ac0d856b3..0000000000 --- a/doc/src/images/wiggly-example.png +++ /dev/null diff --git a/doc/src/snippets/code/doc_src_examples_svgalib.qdoc b/doc/src/snippets/code/doc_src_examples_svgalib.qdoc index 2ae0fe2a12..cf7f23b529 100644 --- a/doc/src/snippets/code/doc_src_examples_svgalib.qdoc +++ b/doc/src/snippets/code/doc_src_examples_svgalib.qdoc @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only //! [0] myApplication -qws -display svgalib |
