summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Doc: Fix typo in configurationPaul Wicking10 days1-1/+1
| | | | | | | | The typo disables the disabling. Amends d5e49197c7b655d7ff18851fc9ab8fca4a752ca9. Change-Id: I44b04670fe10771066316770aed247f4f2335e71 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Doc: Disable undocumented property warningPaul Wicking11 days1-0/+1
| | | | | | | Temporarily disable "Undocumented property" warning from QDoc Change-Id: Ifa29f30abd1e0e2e009372fa5e04df16e2f35b57 Reviewed-by: Axel Spoerl <axel.spoerl@qt.io>
* Doc: Disable redundant link to self warningPaul Wicking2025-11-071-1/+3
| | | | | | | | | The new warning causes CI failures, disable it until issues have been addressed across the codebase. Pick-to: 6.10 6.8 6.5 Change-Id: I130e8492ef4588d5ef26f24f9d556f1f4b5d87ed Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Collect disabled QDoc warnings to a dedicated qdocconf fileTopi Reinio2025-11-072-4/+6
| | | | | | | | | | | A number of QDoc warnings are ignored for Qt module documentation builds. Add them to a dedicated configuration file, included from compat.qdocconf. Task-number: QTBUG-140629 Change-Id: I6fbe8a54e06e4d03221bc41bc63c0e9697b313d5 (cherry picked from commit 0e8e804e6b0c845a2214657d731db8e71e927a98) Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Add internalfilepatterns variable configurationPaul Wicking2025-11-041-0/+3
| | | | | | Task-number: QTBUG-141643 Change-Id: Id9ac6089316b12d2b59d82da4ebdd81fa572f472 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Android: Update to Gradle 8.14.3Lars Schmertmann2025-10-051-1/+1
| | | | | | | | | | | | Update to latest version for Gradle: * Gradle 8.14.2 -> 8.14.3 [ChangeLog][Third-Party Code] Updated Gradle to 8.14.3. Pick-to: 6.10 Task-number: QTBUG-137782 Change-Id: If3ee2d99f3f54c2e730b5617a94e9bfcbd4ac4b2 Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Doc: Add squish testing info to example templateSafiyyah Moosa2025-08-292-3/+3
| | | | | | | | | | | | | | | There is a squish-tested-example.qdocinc file which contains squish testing information for examples. This patch includes this file into the app-exampls-template file as an optional section. It should be added if the example was tested with squish. The README was also updated to include this information. Fixes: QTBUG-139284 Pick-to: 6.10 Change-Id: I69fde08cab19fb81897de2066e553a9d4a51d823 Reviewed-by: Jerome Pasion <jerome.pasion@qt.io>
* Doc: Adjust the title of \externalpage topic causing linking issuesTopi Reinio2025-08-271-1/+1
| | | | | | | | | | | | | | | A double-colon in a link target causes QDoc to treat it as a qualified name of an API entity, causing the link resolution to fail. Drop the double-colons from the \title; fixes QDoc warnings such as src/testlib/doc/qtestcase.qdoc: (qdoc) warning: Can't link to 'std::literals::chrono_literals Symbol Index' Pick-to: 6.10 6.9 6.8 Change-Id: Ibf848e776a23e5528a8a98b7dddf943f0084efb2 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update section title in app examples templateSafiyyah Moosa2025-08-212-4/+4
| | | | | | | | | | | This patch changes the 'relevant classes' section title to 'relevant modules and classes'. This makes it more inclusive and it can be applicable to either modules or classes. Fixes: QTBUG-139292 Pick-to: 6.10 Change-Id: I418edadd1b58d12ad6f7c82b2aed53bf53abdc6a Reviewed-by: Jerome Pasion <jerome.pasion@qt.io>
* Doc: Make 'Platform Notes' optional in templateSafiyyah Moosa2025-08-212-5/+10
| | | | | | | | | | | | | | | Currently the app-examples-template.qdoc file contains a mandatory 'Platform Notes' section. This section lists the different platforms that the example can be run on. Since all Qt application examples are cross-platform, this information is not necessary. This patch states that the 'Platform Notes' section is optional and should be used if there are any plaform limitations or exceptions. Fixes: QTBUG-139286 Pick-to: 6.10 Change-Id: Iad10b1cc5a5ca4880e92327d1ffd77b61988e72d Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Add squish-tested-example.qdocinc to global includesKonsta Alajärvi2025-08-211-0/+18
| | | | | | | | | | | | Add squish-tested-example.qdocinc for global accessibility in all submodules. This precedes a patch removing the file from qdoc module. Task-number: QTBUG-139338 Pick-to: 6.10 Change-Id: I278e8d723cda1c4d530120bfcbc7fb7916c533a4 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Docs: Enable QtTaskTree docsJarek Kobus2025-08-011-0/+4
| | | | | Change-Id: I6fb98af25046fcb81c071099996e559ae638ca8d Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update link from VxWorks to Qt Creator documentation when QC 17.0 is ↵Inkamari Harjula2025-07-311-0/+5
| | | | | | | | | | | released Externalpage link added. Task-number: QTBUG-135792 Pick-to: 6.10 6.9 Change-Id: Id01bfa9f6773dbc6602c3a5451aa1619b913d116 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Doc: Create app examples templateSafiyyah Moosa2025-07-282-0/+131
| | | | | | | | | | | | | | | We are updating the structure of the application examples. This patch creates a template and a README document that developers can use for creating/updating application examples. This template describes the content that should be included in an application example. Fixes: QTBUG-137901 Pick-to: 6.10 Change-Id: Ida3fd1ee4c0b9136a4eaa55209b75557e3ba8cb5 Reviewed-by: Jerome Pasion <jerome.pasion@qt.io>
* QTRY_*_WITH_TIMEOUT: link to chrono_literals docsMarc Mutz2025-07-181-0/+5
| | | | | | | | | | | This makes it easier for readers to find out what this is, in case they don't know, yet. Amends d4bb448cddce63e0c6a84a86020fa59dd32b2293. Pick-to: 6.10 6.9 6.8 Change-Id: If2130512c34f974a45af19099bc1dd13d006e186 Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
* Doc: Fix path of qt-cmake on WindowsKai Köhne2025-07-071-1/+1
| | | | | | | | Path changed in Qt sometime before 6.8. Pick-to: 6.10 6.9 6.8 Change-Id: I5335d0eed1428801bed77e762b82d69ffb2437f8 Reviewed-by: Joerg Bornemann <joerg.bornemann@qt.io>
* Android: update to Gradle 8.14.2 and AGP 8.10.1Assam Boudjelthia2025-06-281-2/+2
| | | | | | | | | | | | | Update to latest versions for Gradle: * Gradle 8.12 -> 8.14.0 * Android Gradle Plugin 8.8.0 -> 8.10.1. [ChangeLog][Third-Party Code] Updated Gradle to 8.14.1 and AGP to 8.10.1. Task-number: QTBUG-137782 Change-Id: Ifbc808e18412f6e2e45612612d36a1f9bf57c1a9 Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
* Introduce _qt_internal_append_cmake_configure_dependsAlexey Edelev2025-06-121-1/+1
| | | | | | | | | | | | The function append the unique entries to the CMAKE_CONFIGURE_DEPENDS property. This suppress the ninja recompat issue, which complains about the duplicated entries in that come from the CMAKE_CONFIGURE_DEPENDS property. It's likely the CMake issue, but we may work around it. Pick-to: 6.8 6.9 6.10 Change-Id: I2f10834b0dca3d2aa08fe13fba69849e97fa77d0 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
* Doc: Adjust styling of QML property signatures in offline docsTopi Reinio2025-06-112-0/+8
| | | | | | | | | | | | | | | | | | | | | Recent changes in QDoc's output for QML type reference pages included rearranging the `extra synopsis` element, i.e, read-only, since, and deprecation information for properties. As a result, the existing CSS for the offline documentation caused some elements to be rendered on top of each other when using the qlitehtml- based backend in Qt Assistant and Qt Creator. To fix the layout, set a fixed width for the table elements that are used to display the properties, property groups, and methods. This change brings the style of QML reference pages closer to that of C++ reference, where signatures also have a fixed width. Pick-to: 6.10 6.9 6.8 Fixes: QTBUG-136990 Change-Id: I72adbeaca46cd9dd99c54368257268dc8db6bfdc Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: David Boddie <david.boddie@qt.io>
* Doc: Update the HTML tab configVenugopal Shivashankar2025-05-301-1/+1
| | | | | | | | | - Added translat='no' attribute to input and style - Added the missing linefeeds Change-Id: I51ffe1bd0eb8d06bab7a7eedcd862e88fe794588 Pick-to: 6.9 6.8 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Enable automatic linking to sources on code.qt.ioTopi Reinio2025-05-2725-0/+75
| | | | | | | | | | | | Since 6.10, QDoc is capable of generating links to the declaration in the source code for each documented C++ API entity in their `Detailed description`. Add the required configuration to enable this feature in online documentation builds. Change-Id: Iaafabc5aea50a6cd72549bb1c04007bb4de498ca Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update external links to Qt Creator docs to 16.0.0 levelLeena Miettinen2025-05-261-8/+140
| | | | | | | | | | Mostly additions, but some title changes, too. Pick-to: 6.8 6.9 Change-Id: Ic911183c1ad77f68f2fc958d82456010b8ce8201 Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io> Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io>
* Revert "Doc: Modify \tabcontent..\endtabcontent macros"Topi Reinio2025-04-281-4/+4
| | | | | | | | | | | | | | | | | | | | | This reverts commit 5c0b08a20dd14f7fd8632495aa911fe427f58f7f. After the original commit, DocBook support for tabbed content was introduced (as format-specific macros). This means that the original macros will also have to be HTML-format specific, as macros cannot have both default and format-specific variants defined. In addition to reverting, add linefeeds to (end)tabcontent.HTML macros to solve the same problem that the reverted commit did. In passing, fix an issue with the tabcontent.DocBook macro; it takes a single argument, therefore the placeholder for the value must be \1. Change-Id: I90ed6bc37d70c10754b3b810198ac44fcd189766 Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: David Boddie <david.boddie@qt.io>
* Implement \tabs for DocBookThibaut Cuvelier2025-04-031-2/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The existing implementation only works for online HTML and the workaround generates nonsensical DocBook that not a single processor could parse. This implementation is not ideal, but gives enough information for processors to do their job (i.e. the tab title and contents are uniquely linked, the tabs in a group are related). Unaware processors still render useful information to the user thanks to links. The ideal presentation would use a container such as `formalgroup` for the tabs, but there is no notion of tab in DocBook. The missing part in this patch is allowing all uses of tabs with DocBook; they are still guarded by `\if defined(onlinedocs)`. For instance, this change updates `porting-to-ios.xml` from: ```xml <db:listitem…> <db:para>If your application uses imports or plugins that depend on special Qt modules, these Qt modules should be added to your build configuration file. For example, if your application uses the Qt Multimedia import in QML, you should add the following to your .pro or CMakeLists.txt file: </db:para> <db:section xml:id="using-cmake"> <db:title>Using CMake</db:title> <db:programlisting language="cpp" role="bad">find_package(Qt6 REQUIRED COMPONENTS Multimedia) target_link_libraries(my_project PRIVATE Qt6::Multimedia) </db:programlisting> </db:section> <db:section xml:id="using-qmake"> <db:title>Using qmake</db:title> <db:programlisting language="cpp" role="bad">QT += multimedia </db:programlisting> <db:para>In Qt for iOS, everything is compiled statically and placed into the application bundle. The applications are &quot;sandboxed&quot; inside their bundles and cannot make use of shared object files. Because of this, also the plugins used by the Qt modules need to be statically linked. To do this, define the required plugins using the <db:link xlink:href="qmake-variable-reference.xml#qtplugin">QTPLUGIN</db:link> variable.</db:para> </db:section> ``` to: ```xml <db:listitem…> <db:para>If your application uses imports or plugins that depend on special Qt modules, these Qt modules should be added to your build configuration file. For example, if your application uses the Qt Multimedia import in QML, you should add the following to your .pro or CMakeLists.txt file: </db:para> <db:bridgehead xml:id="tab-cmake" renderas="sect5" role="tabbed checked tab-group_build-ios-app" xlink:href="#tab-cmake_contents">CMake</db:bridgehead> <db:bridgehead xml:id="tab-qmake" renderas="sect5" role="tabbed checked tab-group_build-ios-app" xlink:href="#tab-qmake_contents">qake</db:bridgehead> <db:sidebar xml:id="tab-cmake_contents"> <db:programlisting language="cpp" role="bad">find_package(Qt6 REQUIRED COMPONENTS Multimedia) target_link_libraries(my_project PRIVATE Qt6::Multimedia) </db:programlisting> </db:sidebar> <db:sidebar xml:id="tab-qmake_contents"> <db:programlisting language="cpp" role="bad">QT += multimedia </db:programlisting> </db:sidebar> ``` Change-Id: I63f3e8d03a5f4ee52e7c67971d14d4497dd78cb8 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Doc: Update copyright year in the global configurationTopi Reinio2025-03-275-5/+5
| | | | | | | Pick-to: 6.9 6.8 6.5 Fixes: QTBUG-134788 Change-Id: I118d15df4e644dbed1a3de5efdb0b5d5a0e11c20 Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Drop "Unknown base" spurious regex from configPaul Wicking2025-03-261-2/+1
| | | | | | | | | | | | | This regex pattern instructs QDoc to not include the matching warning in its warning count. The warning has changed to a report, however, which won't count towards the warning count in any case, so the regexp isn't needed anymore. Task-number: QTBUG-131459 Task-number: QTBUG-134219 Pick-to: 6.9 6.8 Change-Id: Ic461c63b62bd25fb2d1f3b485c46db55e52e20cf Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Docs: Replace supported Android NDK r26b with r27cNicholas Bennett2025-03-251-2/+2
| | | | | | | | | | Updated the macros in qtbase to propagate changes to other doc projects. A separate change has been raised to handle multiple supported ndks in prior LTSs Task-number: QTQAINFRA-6479 Change-Id: Ic052f1b6b80473cc33c7f2be23049969d3cec0ee Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Doc: Don't add padding to div that wraps the pre elementAndreas Eliasson2025-03-141-2/+2
| | | | | | | | | | | | The current style adds padding to non-pre elements, such as any p or div elements. The final html adds a wrapping div with a .pre class that also gets padding added to it. This patch removes the padding from this wrapping div. Fixes: QTBUG-133710 Pick-to: 6.9 6.8 6.5 Change-Id: I6411dcda9cfed5f0f82d8bd9ea8dc809b1a3b4d6 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Doc: Use Qt Design System colors also in help CSSLeena Miettinen2025-03-046-29/+19
| | | | | | | | | | - Replace colors in offline-dark.css - Do not use the note and attention icons in offline templates Task-number: QTBUG-133761 Pick-to: 6.9 6.9.0 6.8 Change-Id: I55e81d6c3887764542e23c8f85f4d46e273b3885 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Long live \constraints!Marc Mutz2025-02-281-0/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We have divergence in the way we document function, operator and constructor constraints. About half use \note, while the other doesn't. Some say "if and only if" while others say just "participates only if". So add a qdoc macro, \constraints, to semantically mark up these constraints. It expands to a section titled `Constraints`, and uses a predefined sentence (prefix) for constraints. Documentation for constraints is moved to the end of the comment blocks to separate them from the rest of the text. Apply them to all the standard-ish constraint documentation blocks (grepped for "participate"). I didn't look for other, one-off, ways documentation authors may have documented constraints, but I'm also not aware of any. Re-wrap lines only if the result fits into a single line. As a drive-by, drop additional "if"s, as in "only if X and -if- Y" to make the texts work with the `Constraints` section. Fixes: QTBUG-106871 Pick-to: 6.9 6.8 6.5 Change-Id: I18c2f9f734474017264e49165389f8c9c7f34030 Reviewed-by: Kai Köhne <kai.koehne@qt.io> Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Docs: Create \Q4A macro for "Qt for Android" and replace instancesNicholas Bennett2025-02-282-1/+2
| | | | | | | | | | | | | | "Android" is trademarked and needs to be referenced in a certain way. The following steps were taken: -Created qdoc macro. -Updated "Qt Android" and "Qt for Android" to use \Q4A in qdoc files. The macro will need to be adopted in all documentation projects. Task-number: QAA-2836 Pick-to: 6.9 6.8 6.5 Change-Id: I4b52247a4ed52047242a06404e6d3aa19de9c16c Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io>
* Android: update Android SDK to version 35.0.1Rami Potinkara2025-02-261-1/+1
| | | | | | | | | | | | | | | This patch updates the macro AndroidBuildToolsVer to version 35.0.1. The version 35.0.1 is used elsewhere, see b49421a984ac2b203b7995f3787b67184c990089 Amends: 9b475eadfcf04194a094454f65295c3a456000a4 Task-number: QTBUG-129462 Pick-to: 6.9 6.8 6.5 Change-Id: Ic15e12c563fa3d16315daa13b6f6b6ef19535954 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Remove references to the deprecated QtCharts moduleTomi Korpipaa2025-02-241-1/+0
| | | | | | | Task-number: QTBUG-133659 Change-Id: I3220c4f63c5ae00dbd1786daf8d09c07d8139a4c Reviewed-by: Miikka Heikkinen <miikka.heikkinen@qt.io> Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Doc: Ignore 'Unknown base <type> for QML type' warnings for nowTopi Reinio2025-02-181-1/+2
| | | | | | | | | | | | | These warnings are false positives when testing in the CI when a documentation module containing the base type is meant to be loaded as a dependency; In the CI, the .index files for doc dependencies are not available so we see this warning. Ignore these warnings for now in the global documentation config. Pick-to: 6.9 6.8 Change-Id: Ic1711bf7389e9f9d4a04e3b72b2c9f8b25539357 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Android: update Android 15 SDK 35 to docsRami Potinkara2025-02-141-4/+4
| | | | | | | | | | | | | This patch updates the macros for Android maxApiVer, AndroidMaxVer, AndroidPlatformVer, AndroidBuildToolsVer variables to reflect Android 15 Task-number: QTBUG-129462 Pick-to: 6.9 6.8 6.5 Change-Id: Ia6edfa7811dd8c98a0a99c10d8781aa09384bdfa Reviewed-by: Assam Boudjelthia <assam.boudjelthia@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Remove references to the deprecated QtDataVisualization moduleTomi Korpipaa2025-02-131-3/+0
| | | | | | Task-number: QTBUG-133658 Change-Id: Ibf8123ffacf6fc4cc02817a5d2ac380ff317f815 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io>
* Fix or remove broken and outdated external links in qtbase documentationDavid Boddie2025-02-081-182/+72
| | | | | | Change-Id: Ia78b3b16b89ab3f80d990b6e338b4a0f294ab1ed Pick-to: 6.8 6.9 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Clean up output for tabbed content macroTopi Reinio2025-02-081-1/+1
| | | | | | | | | | | Insert line breaks in the content the \tab macro expands to. This produces nicer-looking html and also fixes an issue related to the post-processing done to the generated files. Fixes: QTWEBSITE-1202 Pick-to: 6.9 6.8 Change-Id: If4e7f7242f8687ef84ad715744653c4167cf907f Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
* Doc: Update external link to freedesktop.org trash specificationKai Köhne2025-01-271-1/+1
| | | | | | | | | Old link gives a 404 Pick-to: 6.9 Change-Id: I3e528a29a6ed2d0d97c3fcf1cf11c441a2882415 Reviewed-by: Volker Hilsheimer <volker.hilsheimer@qt.io> Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Doc: Fix link to RFC 8259Kai Köhne2025-01-271-5/+5
| | | | | | | | | | | | Fixes qdoc warning corelib/doc/src/json.qdoc:22: (qdoc) warning: Can't link to 'RFC 8259' Amends 65fda988e92e Pick-to: 6.9 Change-Id: I62c1cf05366cd13180d21d7b4cbf68c0c0f48e1d Reviewed-by: Johannes Grunenberg <nerixdev@outlook.de> Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>
* Doc: Modify \tabcontent..\endtabcontent macrosTopi Reinio2025-01-091-2/+2
| | | | | | | | | | | | | | | QDoc markup following the \tabcontent macro should start a new paragraph. As HTML-specific macros are injected directly into the output, QDoc's doc parser is not aware that the macro should start a new paragraph. Turn the macros into generic, non-format-specific macros, expanding to \div and \enddiv commands that wrap the tab content. Pick-to: 6.9 6.8 6.5 Change-Id: Ie8313af391b1a38ef74592acac3198fef5b7b310 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
* Android: document androidtestrunner toolAssam Boudjelthia2024-12-191-0/+4
| | | | | | | | | Add documentation and usage of androidtestrunner tool. Pick-to: 6.9 6.8 Fixes: QTBUG-84330 Change-Id: I03aa67ebf0ba807f20595547f2598d905080a878 Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
* Doc: Fix usage instructions for the \youtube macroTopi Reinio2024-12-181-1/+2
| | | | | | | | | | | The example configuration included a space character that caused a syntax error parsing the .qdocconf. Replace the hardcoded qhp `QtDoc` project name with a placeholder. Pick-to: 6.9 6.8 Change-Id: Iadf3a50e030f02182016ed9832f4f59d29f82c57 Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Doc: Set trademarks page in global configurationTopi Reinio2024-12-091-0/+3
| | | | | | | | | | | | | The new \tm command appends a trademark symbol and links to the trademark documentation page if `navigation.trademarkspage` variable is set. As we have such a page in qtdoc repository, set the variable in the global configuration. This works as all Qt module docs have a dependency to the `qtdoc` documentation set. Pick-to: 6.8 Task-number: QTBUG-124393 Change-Id: Iabc6e7e5afe5114eac79947f0feb512458f1c4da Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
* Docs: Fix broken layout on landing page (dark offline style)Eike Ziller2024-12-061-5/+3
| | | | | | | | | | | | | | The style was already fixed for the "light" offline style, but the dark offline style was missed. Amends d39c9d37ade8d74e534952e47061168be8904fc7 Task-number: QTBUG-129178 Fixes: QTBUG-131950 Pick-to: 6.8 Change-Id: I4f005cbe1945b8a973fb7bf77fb56b4d59d96b9c Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Kai Köhne <kai.koehne@qt.io>
* Create qdoc macros for C++ class docs 2.1: qHash()Marc Mutz2024-11-271-0/+55
| | | | | | | | | | | | | | | | | | | | | | | | | | Add a family of qdoc macros to document the various qHash() overloads we have. This patch does not change the \relates of the qHash() functions, they remain as inconsistent as they have been. Created QTBUG-129815 to clean things up. Since this author expects the \relates to change in the future, there are different \qhash commands, and all except \qhashbuiltin take the class name as an argument, for use in a centrally-choreographed fix for QTBUG-129815. As drive-by's, fix: - missing documentation about Key having to support qHash() in the associative Qt containers - drop noexcept and default arguments from \fn lines that needed to have their argument names changed - move the QStringView overload from qhash.cpp to qstringview.cpp (as it \relates to the former) Fixes: QTBUG-129574 Pick-to: 6.8 6.5 Change-Id: I8e8c2edc27422cbe5823f56baf3a24d7f7050836 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io> Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
* Remove unusable Q_OBJECT qdoc macroKai Köhne2024-11-191-1/+0
| | | | | | | | | | | | | Commit e2ff9e3b9957 was adding Q_OBJECT as a qdoc macro to allow to mask Q_OBJECT calls that are part of the documentation. Anyhow, while qdoc does allow the underscore in the _definition_ of macros, it doesn't allow it for the _invocation_. The questionable places should rather use snippet files. Fixes: QTBUG-130799 Pick-to: 6.8 Change-Id: I13bac0334b67ba7072946ab7d3f34c7a304c3f84 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
* Add new icons for the tools doc front page templateInkamari Harjula2024-11-113-0/+0
| | | | | | | Icons folder-32x32.png, paste_general-32x32.png, and web-32x32.png added. Change-Id: I3b744f38a8654874a127eac6a161f38e52287ac6 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
* Create qdoc macros for C++ class docs 1.2: member-swap(), simplified phrasingMarc Mutz2024-11-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | We have some patterns for how to document certain functions, but we also vary the sentences a lot, and you have to look up one documentation piece and copy it, essentially. If we ever want to change them, we end up with shotgun surgery. So apply DRY to the documentation and start a collection of macros to help with repetitive C++ class documentation tasks. The first macro is for member-swap(), and this second patch is for documentation that used the simplified phrasing ("Swaps this X with \a other."), which this patch adopts as the text for \memberswap, too, because it doesn't repeat the macro argument, making it easier to find a grammatically-fitting argument than in the traditional phrasing. This doesn't change the documentation, except as follows: * standardizes on simpified instead of traditional phrasing for docs that already use the \memberswap macro * adds the "very fast and never fails" blurb, if it was missing * changes the function's argument name to `other`, as required by the macro. Task-number: QTBUG-129573 Pick-to: 6.8 6.7 6.5 6.2 Change-Id: I1123e783ce0da76c5997ff74007d77504ac5b334 Reviewed-by: Topi Reiniö <topi.reinio@qt.io> Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
* Create qdoc macros for C++ class docs 1.1: member-swap(), traditional phrasingMarc Mutz2024-11-052-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | We have some patterns for how to document certain functions, but we also vary the sentences a lot, and you have to look up one documentation piece and copy it, essentially. If we ever want to change them, we end up with shotgun surgery. So apply DRY to the documentation and start a collection of macros to help with repetitive C++ class documentation tasks. The first macro is for member-swap(), and the first patch is for documentation that used the traditional phrasing ("Swaps the X \a other with this X."). This doesn't change the documentation, except as follows: * adds the "very fast and never fails" blurb, if it was missing * changes the function's argument name to `other`, as required by the macro. Task-number: QTBUG-129573 Pick-to: 6.8 6.7 6.5 6.2 Change-Id: Ib494bd218334724b3b43796ba6f71fb52b83aa94 Reviewed-by: Ivan Solovev <ivan.solovev@qt.io>
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-23 11:27:54 +0000