diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README | 109 | ||||
| -rw-r--r-- | doc/global/externalsites/external-resources.qdoc | 4 | ||||
| -rw-r--r-- | doc/global/externalsites/rfc.qdoc | 10 | ||||
| -rw-r--r-- | doc/global/macros.qdocconf | 12 | ||||
| -rw-r--r-- | doc/src/images/coloreditorfactoryimage.png | bin | 12209 -> 0 bytes | |||
| -rw-r--r-- | doc/src/images/groupbox-example.png | bin | 9706 -> 0 bytes |
6 files changed, 24 insertions, 111 deletions
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/global/externalsites/external-resources.qdoc b/doc/global/externalsites/external-resources.qdoc index 272c73b3b0..0dcea08a53 100644 --- a/doc/global/externalsites/external-resources.qdoc +++ b/doc/global/externalsites/external-resources.qdoc @@ -33,6 +33,10 @@ \title Android: Tagged Pointers */ /*! + \externalpage https://developer.android.com/build/configure-app-module + \title Android: Configure the app module +*/ +/*! \externalpage https://developer.apple.com/documentation/uikit/uiapplication/1622952-canopenurl \title iOS: canOpenURL: */ diff --git a/doc/global/externalsites/rfc.qdoc b/doc/global/externalsites/rfc.qdoc index b6646f453c..ceab869bfd 100644 --- a/doc/global/externalsites/rfc.qdoc +++ b/doc/global/externalsites/rfc.qdoc @@ -125,6 +125,11 @@ */ /*! + \externalpage https://datatracker.ietf.org/doc/html/rfc6698 + \title RFC 6698 +*/ + +/*! \externalpage https://datatracker.ietf.org/doc/html/rfc7049 \title RFC 7049 */ @@ -150,6 +155,11 @@ */ /*! + \externalpage https://datatracker.ietf.org/doc/html/rfc7858 + \title RFC 7858 +*/ + +/*! \externalpage https://datatracker.ietf.org/doc/html/rfc8018#section-5.1 \title RFC 8018, section 5.1 */ diff --git a/doc/global/macros.qdocconf b/doc/global/macros.qdocconf index 93c6fa0ab0..d5a5a3264f 100644 --- a/doc/global/macros.qdocconf +++ b/doc/global/macros.qdocconf @@ -56,20 +56,28 @@ macro.examplecategory = "\\meta category {\1}\n\\ingroup category \1" # Macros for product names, sorted in alphabetic order +macro.B2Q = "Boot to Qt" +macro.B2QSS = "Boot to Qt Software Stack" +macro.B2QST = "Boot to Qt Startup Screen" +macro.IFW = "Qt Installer Framework" 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.QC = "Qt Creator" macro.QD = "Qt Widgets Designer" macro.QDS = "Qt Design Studio" macro.QDV = "Qt Design Viewer" +macro.QfP = "Qt for Python" macro.QL = "Qt Linguist" macro.QMCU = "Qt for MCUs" +macro.QMLP = "QML Profiler" macro.QMLLS = "QML Language Server" macro.QMT = "Qt Maintenance Tool" macro.QOI = "Qt Online Installer" +macro.QQEM = "Qt Quick Effect Maker" macro.QQV = "Qt QML Viewer" macro.QtAA = "Qt for Android Automotive" macro.QUL = "Qt Quick Ultralite" @@ -77,7 +85,7 @@ 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.AndroidAbis = "\\c{arm64-v8a}, \\c{x86_64}, \\c{x86}, and \\c{armeabi-v7a}" macro.NdkVer = "r26b" macro.NdkFullVer = "26.1.10909125" macro.NdkCompilerVer = "Clang 17.0.2" @@ -89,7 +97,7 @@ macro.AndroidMaxVer = "14" macro.AndroidPlatformVer = "34" macro.AndroidBuildToolsVer = "34.0.0" macro.GradleVer = "8.3" -macro.AGPVer = "7.4.1" +macro.AGPVer = "8.2.2" macro.AAOSVer = "10 to 13" macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">" 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/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 |
