diff options
| author | Kai Köhne <kai.koehne@qt.io> | 2021-09-06 16:14:50 +0200 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2021-09-27 14:57:02 +0000 |
| commit | 062db8a8c286530a68d6c035e1bf9ba7ef956a3b (patch) | |
| tree | 70d3014c993f134506e66edcb73077dd05ee2523 | |
| parent | 0839ca39affda194a86e4d957292a96242e9ffde (diff) | |
Document Qt Assistant licenses
Make sure that the 3rd party qlitehtml licenses are visible in the
Qt Assistant documentation. This also requires a small extension for
qtattributionsscanner, so that 'tools' documentation can be picked up,
too.
Change-Id: Ib90004c1f3c74b42cbf00156674fab92d59057a8
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
(cherry picked from commit d2fc6facca4ddf889bb4f5d1f60592fd228d246e)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | src/assistant/assistant/doc/qtassistant.qdocconf | 2 | ||||
| -rw-r--r-- | src/assistant/assistant/doc/src/assistant-manual.qdoc | 17 | ||||
| -rw-r--r-- | src/qtattributionsscanner/qdocgenerator.cpp | 4 |
3 files changed, 21 insertions, 2 deletions
diff --git a/src/assistant/assistant/doc/qtassistant.qdocconf b/src/assistant/assistant/doc/qtassistant.qdocconf index 778819176..7b25869d4 100644 --- a/src/assistant/assistant/doc/qtassistant.qdocconf +++ b/src/assistant/assistant/doc/qtassistant.qdocconf @@ -27,7 +27,7 @@ qhp.QtAssistant.subprojects.examples.sortPages = true language = Cpp -sourcedirs = .. +sourcedirs += .. exampledirs = ../../../../examples/assistant \ snippets diff --git a/src/assistant/assistant/doc/src/assistant-manual.qdoc b/src/assistant/assistant/doc/src/assistant-manual.qdoc index 8c2ae44fa..5951c43b3 100644 --- a/src/assistant/assistant/doc/src/assistant-manual.qdoc +++ b/src/assistant/assistant/doc/src/assistant-manual.qdoc @@ -55,6 +55,7 @@ \li \l{Qt Assistant Quick Guide} \li \l{Using Qt Assistant} \li \l{Customizing Qt Assistant} + \li \l{Licenses and Attributions} \endlist */ @@ -63,6 +64,7 @@ \title Customizing Qt Assistant \previouspage Using Qt Assistant + \nextpage Licenses and Attributions Using \QA as custom help viewer requires more than just being able to display custom documentation. It is equally important that the @@ -423,3 +425,18 @@ \li Doesn't show any error, warning or success messages. \endtable */ + +/*! + \page assistant-licenses.html + \title Licenses and Attributions + + \previouspage Customizing Qt Assistant + + \QA is available under commercial licenses from \l{The Qt Company}. In + addition, it is available under the \l{GNU General Public License, version 3}. + + Furthermore, \QA \QtVersion may contain third party modules + under following permissive licenses: + + \generatelist{groupsbymodule attributions-qtassistant-tools} +*/ diff --git a/src/qtattributionsscanner/qdocgenerator.cpp b/src/qtattributionsscanner/qdocgenerator.cpp index 1b02ac367..6c264b752 100644 --- a/src/qtattributionsscanner/qdocgenerator.cpp +++ b/src/qtattributionsscanner/qdocgenerator.cpp @@ -70,8 +70,10 @@ static void generate(QTextStream &out, const Package &package, const QDir &baseD LogLevel logLevel) { out << "/*!\n\n"; - for (const QString &part: package.qtParts) + for (const QString &part : package.qtParts) { + out << "\\ingroup attributions-" << package.qdocModule << "-" << part << "\n"; out << "\\ingroup attributions-" << part << "\n"; + } if (package.qtParts.contains(QLatin1String("libs"))) { // show up in xxx-index.html page of module |