From 676b08f947098a3dd3d417a38631567157c4e757 Mon Sep 17 00:00:00 2001 From: Joerg Bornemann Date: Wed, 15 Apr 2020 06:33:10 +0200 Subject: Doc: Add note about the llvm installer on Windows Note that one has to restart their build shell after installing llvm with the pre-built installer on Windows. Task-number: QTBUG-83429 Change-Id: Ife15ba8179bb53930315f597f05c09bd1a12cbeb Reviewed-by: Leena Miettinen --- src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src') diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 201706b70..07082fa31 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -637,6 +637,10 @@ install the \c libclang-dev package and its dependencies. For running QDoc, the \c libclang package is required. + \note On Windows, after installing the pre-built LLVM you must restart your + build shell to ensure that LLVM's binary directory is added to the PATH + variable. This is needed to be able to run qdoc. + \section1 Set Clang location automatically The Qt build system uses the tool \c llvm-config to discover the location -- cgit v1.2.3 From 11459960cdee71a325c7373992adde8fed1db86a Mon Sep 17 00:00:00 2001 From: Andy Shaw Date: Thu, 16 Apr 2020 09:20:39 +0200 Subject: Parse the otool line when it has ", weak" as part of the it With Xcode 11.4, in some cases it will have ", weak" as part of the framework description when running otool. Therefore we need to account for this so it still sees it as a valid entry. Cherry-picked from branch: dev Change-Id: I4018d42aa54f4e6434ee6defa119f3c913893819 Reviewed-by: cherrypickbot --- src/macdeployqt/shared/shared.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'src') diff --git a/src/macdeployqt/shared/shared.cpp b/src/macdeployqt/shared/shared.cpp index 607dce880..a81a2f0d9 100644 --- a/src/macdeployqt/shared/shared.cpp +++ b/src/macdeployqt/shared/shared.cpp @@ -183,7 +183,7 @@ OtoolInfo findDependencyInfo(const QString &binaryPath) static const QRegularExpression regexp(QStringLiteral( "^\\t(.+) \\(compatibility version (\\d+\\.\\d+\\.\\d+), " - "current version (\\d+\\.\\d+\\.\\d+)\\)$")); + "current version (\\d+\\.\\d+\\.\\d+)(, weak)?\\)$")); QString output = otool.readAllStandardOutput(); QStringList outputLines = output.split("\n", Qt::SkipEmptyParts); -- cgit v1.2.3 From d690a99b99ce68cee6bde71e12a3fc6190812f3f Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 7 Apr 2020 12:21:32 +0200 Subject: qdoc: Remove defunct code for 'edition' qdocconf variable There was some old code and documentation for this variable, but using it had no effect on the output. Similarly, the \generatelist command no longer recognized the edition-specific parameter. Fixes: QTBUG-83367 Change-Id: I42a1e67855ffd781e326e9d89cec0dde51cb14d0 Reviewed-by: Paul Wicking --- src/qdoc/config.cpp | 1 - src/qdoc/config.h | 2 -- src/qdoc/doc/qdoc-manual-qdocconf.qdoc | 36 ++-------------------------------- src/qdoc/generator.h | 2 -- src/qdoc/htmlgenerator.cpp | 13 ------------ 5 files changed, 2 insertions(+), 52 deletions(-) (limited to 'src') diff --git a/src/qdoc/config.cpp b/src/qdoc/config.cpp index 1387fb411..9ff22c8b1 100644 --- a/src/qdoc/config.cpp +++ b/src/qdoc/config.cpp @@ -57,7 +57,6 @@ QString ConfigStrings::DEFINES = QStringLiteral("defines"); QString ConfigStrings::DEPENDS = QStringLiteral("depends"); QString ConfigStrings::DESCRIPTION = QStringLiteral("description"); QString ConfigStrings::DOCBOOKEXTENSIONS = QStringLiteral("usedocbookextensions"); -QString ConfigStrings::EDITION = QStringLiteral("edition"); QString ConfigStrings::ENDHEADER = QStringLiteral("endheader"); QString ConfigStrings::EXAMPLEDIRS = QStringLiteral("exampledirs"); QString ConfigStrings::EXAMPLES = QStringLiteral("examples"); diff --git a/src/qdoc/config.h b/src/qdoc/config.h index f8823d521..933aad543 100644 --- a/src/qdoc/config.h +++ b/src/qdoc/config.h @@ -228,7 +228,6 @@ struct ConfigStrings static QString DEPENDS; static QString DESCRIPTION; static QString DOCBOOKEXTENSIONS; - static QString EDITION; static QString ENDHEADER; static QString EXAMPLEDIRS; static QString EXAMPLES; @@ -315,7 +314,6 @@ struct ConfigStrings #define CONFIG_DEPENDS ConfigStrings::DEPENDS #define CONFIG_DESCRIPTION ConfigStrings::DESCRIPTION #define CONFIG_DOCBOOKEXTENSIONS ConfigStrings::DOCBOOKEXTENSIONS -#define CONFIG_EDITION ConfigStrings::EDITION #define CONFIG_ENDHEADER ConfigStrings::ENDHEADER #define CONFIG_EXAMPLEDIRS ConfigStrings::EXAMPLEDIRS #define CONFIG_EXAMPLES ConfigStrings::EXAMPLES diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc index 6d26de344..5f43a1d41 100644 --- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -91,7 +91,6 @@ \li \l {Cpp.ignoretokens-variable} {Cpp.ignoretokens} \li \l {defines-variable} {defines} \li \l {depends-variable} {depends} - \li \l {edition-variable} {edition} \li \l {exampledirs-variable} {exampledirs} \li \l {examples-variable} {examples} \li \l {examples.fileextensions-variable} {examples.fileextensions} @@ -244,10 +243,10 @@ line using the -D option. For example: \badcode - currentdirectory$ qdoc -Dconsoleedition qtgui.qdocconf + currentdirectory$ qdoc -Dqtforpython qtgui.qdocconf \endcode - In this case the -D option ensures that the \c consoleedition + In this case the -D option ensures that the \c qtforpython preprocessor symbol is defined when QDoc processes the source files defined in the qtgui.qdocconf file. @@ -305,37 +304,6 @@ See also \l indexes, \l project, and \l url. - \target edition-variable - \section1 edition - - The \c edition variable specifies which modules are included in - each edition of a package, and provides QDoc with information to - provide class lists for each edition. - - This feature is mostly used when providing documentation for Qt - packages. - - The \c edition variable is always used with a particular edition - name to define the modules for that edition: - - \badcode - edition.Console = QtCore QtNetwork QtSql QtXml - edition.Desktop = QtCore QtGui QtNetwork QtOpenGL QtSql QtXml \ - QtDesigner QtAssistant Qt3Support QAxContainer \ - QAxServer - edition.DesktopLight = QtCore QtGui Qt3SupportLight - \endcode - - In the above examples, the \c Console edition only includes the - contents of four modules. Only the classes from these modules will - be used when the \l{Miscellaneous#generatelist-command} - {generatelist} command is used to generate a list of classes for - this edition: - - \badcode - \generatelist{classesbyedition Console} - \endcode - \target exampledirs-variable \section1 exampledirs diff --git a/src/qdoc/generator.h b/src/qdoc/generator.h index f12aff933..dca915ba7 100644 --- a/src/qdoc/generator.h +++ b/src/qdoc/generator.h @@ -159,8 +159,6 @@ protected: static bool hasExceptions(const Node *node, NodeList &reentrant, NodeList &threadsafe, NodeList &nonreentrant); - QMap editionGroupMap; - QMap editionModuleMap; QString naturalLanguage; #ifndef QT_NO_TEXTCODEC QTextCodec *outputCodec; diff --git a/src/qdoc/htmlgenerator.cpp b/src/qdoc/htmlgenerator.cpp index 104d97bc2..a1a1cd876 100644 --- a/src/qdoc/htmlgenerator.cpp +++ b/src/qdoc/htmlgenerator.cpp @@ -185,19 +185,6 @@ void HtmlGenerator::initializeGenerator() if (naturalLanguage.isEmpty()) naturalLanguage = QLatin1String("en"); - const QSet editionNames = config->subVars(CONFIG_EDITION); - for (const auto &editionName : editionNames) { - QStringList editionModules = config->getStringList(CONFIG_EDITION + Config::dot - + editionName + Config::dot + "modules"); - QStringList editionGroups = config->getStringList(CONFIG_EDITION + Config::dot + editionName - + Config::dot + "groups"); - - if (!editionModules.isEmpty()) - editionModuleMap[editionName] = editionModules; - if (!editionGroups.isEmpty()) - editionGroupMap[editionName] = editionGroups; - } - codeIndent = config->getInt(CONFIG_CODEINDENT); // QTBUG-27798 codePrefix = config->getString(CONFIG_CODEPREFIX); codeSuffix = config->getString(CONFIG_CODESUFFIX); -- cgit v1.2.3 From 0214ec3e091f69bd9b8ebeed2bc9a6cd88882059 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 15 Apr 2020 13:08:34 +0200 Subject: Doc: QDoc Manual: Refer to the tool as 'QDoc' consistently And add 'QDoc' as a word ignored for auto-linking. Change-Id: I16a33b8448e8bfa340f4c62149f702fea13d5533 Reviewed-by: Leena Miettinen Reviewed-by: Paul Wicking --- src/qdoc/doc/config/qdoc.qdocconf | 2 ++ src/qdoc/doc/examples/samples.qdocinc | 4 +-- src/qdoc/doc/qa-pages.qdoc | 12 ++++----- src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 10 +++---- src/qdoc/doc/qdoc-manual-intro.qdoc | 4 +-- src/qdoc/doc/qdoc-manual-markupcmds.qdoc | 46 ++++++++++++++++---------------- src/qdoc/doc/qdoc-manual-qdocconf.qdoc | 18 ++++++------- src/qdoc/doc/qdoc-manual-topiccmds.qdoc | 2 +- src/qdoc/doc/qtgui-qdocconf.qdoc | 2 +- 9 files changed, 51 insertions(+), 49 deletions(-) (limited to 'src') diff --git a/src/qdoc/doc/config/qdoc.qdocconf b/src/qdoc/doc/config/qdoc.qdocconf index f29b20aaf..a850d3eb6 100644 --- a/src/qdoc/doc/config/qdoc.qdocconf +++ b/src/qdoc/doc/config/qdoc.qdocconf @@ -65,4 +65,6 @@ depends += \ qtwidgets \ qtxml +ignorewords += QDoc + navigation.landingpage = "QDoc Manual" diff --git a/src/qdoc/doc/examples/samples.qdocinc b/src/qdoc/doc/examples/samples.qdocinc index afe634326..1b83428b2 100644 --- a/src/qdoc/doc/examples/samples.qdocinc +++ b/src/qdoc/doc/examples/samples.qdocinc @@ -62,10 +62,10 @@ \page generic-guide.html \title Generic QDoc Guide \nextpage Creating QDoc Configuration Files - There are three essential materials for generating documentation with qdoc: + There are three essential materials for generating documentation with QDoc: \list - \li \c qdoc binary + \li \c QDoc binary (\c {qdoc}) \li \c qdocconf configuration files \li \c Documentation in \c C++, \c QML, and \c .qdoc files \endlist diff --git a/src/qdoc/doc/qa-pages.qdoc b/src/qdoc/doc/qa-pages.qdoc index 1e3ca19f4..47f57eb38 100644 --- a/src/qdoc/doc/qa-pages.qdoc +++ b/src/qdoc/doc/qa-pages.qdoc @@ -32,14 +32,14 @@ \title QA Pages - qdoc can generate some extra HTML pages that can be useful for - debugging qdoc documentation. These \e QA pages make it easier for + QDoc can generate some extra HTML pages that can be useful for + debugging QDoc documentation. These \e QA pages make it easier for those who write documentation to find links that either go to the wrong targets or don't go anywhere at all. \section2 Generating the QA Pages - Add \c {-write-qa-pages} to the command line to tell qdoc to + Add \c {-write-qa-pages} to the command line to tell QDoc to generate the QA pages. If this option is not provided, the QA pages will not be generated, and previolusly generated QA pages will be deleted. @@ -49,7 +49,7 @@ The main QA page for a module is not linked into the module's generated documentation, but it is located in the same output directory. To find the top-level QA page for module \e {xxx}, set - your browser to the qdoc output directory for module \e {xxx}. + your browser to the QDoc output directory for module \e {xxx}. Several files whose names begin with \e {aaa} appear at the top of the list. These are the QA pages for module \e{xxx}. The file names begin with \e {aaa} to ensure that they are easy to find at @@ -83,11 +83,11 @@ QtCore to QtQuick. The first column of each table entry contains a link to some link in QtCore. The link text as it appears in QtCore is shown. The second and third columns contain the source - file name and line number for where qdoc saw the link in a qdoc + file name and line number for where QDoc saw the link in a qdoc comment. \note The line number will normally refer to the first line of the - comment where qdoc saw the link. + comment where QDoc saw the link. Clicking on a link in the table takes you to that link in the documentation. There the link will be marked with three red diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index c964493bc..abd2661d8 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -37,7 +37,7 @@ \l{writing-markup}{mark up} to enhance the layout and formatting of the final output. - There are three essential materials for generating documentation with qdoc: + There are three essential materials for generating documentation with QDoc: \list \li \c QDoc binary \li \c qdocconf configuration files @@ -95,12 +95,12 @@ can style the documentation in DITA at a later time. DITA XML is therefore more flexible in allowing different styles to apply to the same information. - To run qdoc, the project configuration file is supplied as an argument. + To run QDoc, the project configuration file is supplied as an argument. \code qdoc project.qdocconf \endcode - The project configuration contains information that qdoc uses to create the + The project configuration contains information that QDoc uses to create the documentation. \section2 Project Information @@ -267,7 +267,7 @@ comment; the comment itself and anything after it, until a newline, is omitted from the generated output. - QDoc will parse C++ and QML files to look for qdoc comments. To explicitly + QDoc will parse C++ and QML files to look for QDoc comments. To explicitly omit a certain file type, omit it from the \l{Input and Output Directories}{configuration} file. @@ -280,7 +280,7 @@ \target writing-topic-commands \section2 QDoc Topics - Each qdoc comment must have a \e topic type. A topic distinguishes it from + Each QDoc comment must have a \e topic type. A topic distinguishes it from other topics. To specify a topic type, use one of the several \l{Topic Commands}{topic commands}. diff --git a/src/qdoc/doc/qdoc-manual-intro.qdoc b/src/qdoc/doc/qdoc-manual-intro.qdoc index a943863a6..525445b4f 100644 --- a/src/qdoc/doc/qdoc-manual-intro.qdoc +++ b/src/qdoc/doc/qdoc-manual-intro.qdoc @@ -88,7 +88,7 @@ \section1 Running QDoc - The name of the QDoc program is \c {qdoc}. To run qdoc from the + The name of the QDoc program is \c {qdoc}. To run QDoc from the command line, give it the name of a configuration file: \quotation @@ -284,7 +284,7 @@ For each QDoc comment it finds, it searches the master tree for the item where the documentation belongs. Then it interprets the - qdoc commands in the comment and stores the interpreted commands + QDoc commands in the comment and stores the interpreted commands and the comment text in the tree node for the item. Finally, QDoc traverses the master tree. For each node, if the diff --git a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc index 6fc16c9e1..69d10fb9a 100644 --- a/src/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -206,9 +206,9 @@ text (which may include other QDoc commands) to which special formatting attributes should be applied. - An argument must be provided in curly braces, as in the qdoc + An argument must be provided in curly braces, as in the QDoc comment shown below. The argument is not interpreted but is used - as attribute(s) of the tag that is output by qdoc. + as attribute(s) of the tag that is output by QDoc. For example, we might want to render an inline image so that it floats to the right of the current block of text: @@ -222,7 +222,7 @@ * / \endcode - If qdoc is generating HTML, it will translate these commands to: + If QDoc is generating HTML, it will translate these commands to: \code

@@ -1699,7 +1699,7 @@ ... \endcode - By default, qdoc looks for \c{//!} as a code snippet marker. + By default, QDoc looks for \c{//!} as a code snippet marker. For \c{.pro}, \c{.py}, \c{.cmake}, and \c{CMakeLists.txt} files, \c {#!} is detected. Finally, \c{