From db48c49af94b13bf33edf6e0bcad6fe77f988c28 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Wed, 8 Apr 2015 12:43:38 +0200
Subject: [PATCH] Doc: add a "commercial" icon to commercial-only topics
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
For purely commercial apps, this is done by using the
template, but Qt Creator is mostly open source, so an
image is used.
Use a \commercial macro with a tooltip and link to the
image.
Change-Id: I5e3df953821551331afef2ec642b482b52ff909e
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
---
doc/config/images/commercial.png | Bin 0 -> 334 bytes
doc/config/macros.qdocconf | 1 +
doc/config/qtcreator-project.qdocconf | 4 ++++
doc/src/analyze/cpu-usage-analyzer.qdoc | 2 ++
.../analyze/creator-clang-static-analyzer.qdoc | 2 ++
doc/src/howto/creator-autotest.qdoc | 2 ++
doc/src/overview/creator-commercial-overview.qdoc | 2 ++
doc/src/qtquick/qtquick-connection-editor.qdoc | 2 ++
doc/src/qtquick/qtquick-designer-extensions.qdoc | 2 ++
doc/src/qtquick/qtquick-pathview-editor.qdoc | 2 ++
10 files changed, 19 insertions(+)
create mode 100644 doc/config/images/commercial.png
diff --git a/doc/config/images/commercial.png b/doc/config/images/commercial.png
new file mode 100644
index 0000000000000000000000000000000000000000..852737d4bcb5c55e7e7b72066d26f5715a780073
GIT binary patch
literal 334
zcmV-U0kQsxP)<h;3K|Lk000e1NJLTq001-q002P<0{{R3sY!RM0001rP)t-sT&fiR
z|NqJS|Nr*JU8+)EtVQ$x|NrNgU#l{3suO*w6T|uc{r~-~?e>o2?a}S%|NZC1*0P4X
zY0&xq|Nry)_T<Il*r(pu>*>f{$Hh#$t*z3mcEqRu>7?`Iq}bb^(bS)q#**yZiCV3E
zo4|V5&~SXaX<e#cfV4z*v@y=UES9VgpQsSJwgyW~B1QlJ0DnnDK~zY`?antA!Y~v>
zQH_O#EN7E*&anUOfg5U1=VEU2t9Rxb5fS-|eL@!NG6OK#1!5#eHm~cctKQwC0`}Ej
z|LEQ<oehRn;7K=w)CN9^hNj2SEwTw;<>L<@EwJIEIK`HK@H9fTKOa`*h1!}qw2p@2
guT66|A|mqh1vRk+2aqIE_5c6?07*qoM6N<$g2(`^F#rGn
literal 0
HcmV?d00001
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf
index 38971f6e67b..0fc61558877 100644
--- a/doc/config/macros.qdocconf
+++ b/doc/config/macros.qdocconf
@@ -34,6 +34,7 @@ macro.begincomment = "\\c{/*}"
macro.endcomment = "\\c{*/}"
macro.uuml.HTML = "ü"
macro.mdash.HTML = "—"
+macro.commercial = "\\raw HTML\n<p><a title=\"Available under certain Qt licenses.\"><img src=\"images/commercial.png\"/></a></p>\n\\endraw"
macro.beginfloatleft.HTML = "<div style=\"float: left; margin-right: 2em\">"
macro.beginfloatright.HTML = "<div style=\"float: right; margin-left: 2em\">"
diff --git a/doc/config/qtcreator-project.qdocconf b/doc/config/qtcreator-project.qdocconf
index d4dc2f247c1..598bd327358 100644
--- a/doc/config/qtcreator-project.qdocconf
+++ b/doc/config/qtcreator-project.qdocconf
@@ -8,6 +8,10 @@ imagedirs = $SRCDIR/images $SRCDIR/templates/images
outputdir = $OUTDIR
exampledirs = $SRCDIR/examples
+HTML.extraimages = images/commercial.png
+qhp.QtCreator.extraFiles = images/commercial.png
+
+
indexes += $QDOC_INDEX_DIR/qtwidgets/qtwidgets.index \
$QDOC_INDEX_DIR/qtcore/qtcore.index \
$QDOC_INDEX_DIR/qtqml/qtqml.index \
diff --git a/doc/src/analyze/cpu-usage-analyzer.qdoc b/doc/src/analyze/cpu-usage-analyzer.qdoc
index 1a2971b79de..e3eb74cdfdc 100644
--- a/doc/src/analyze/cpu-usage-analyzer.qdoc
+++ b/doc/src/analyze/cpu-usage-analyzer.qdoc
@@ -30,6 +30,8 @@
\title Analyzing CPU Usage
+ \commercial
+
\QC is integrated with the Linux Perf tool (commercial only) that can be
used to analyze the CPU usage of an application on embedded devices and, to
a limited extent, on Linux desktop platforms. The CPU Usage Analyzer uses
diff --git a/doc/src/analyze/creator-clang-static-analyzer.qdoc b/doc/src/analyze/creator-clang-static-analyzer.qdoc
index 3485be704fa..b4692213793 100644
--- a/doc/src/analyze/creator-clang-static-analyzer.qdoc
+++ b/doc/src/analyze/creator-clang-static-analyzer.qdoc
@@ -31,6 +31,8 @@
\title Using Clang Static Analyzer
+ \commercial
+
\QC integrates the \l{http://clang-analyzer.llvm.org}
{Clang Static Analyzer} for finding problems in C, C++, and Objective-C
programs (commercial only).
diff --git a/doc/src/howto/creator-autotest.qdoc b/doc/src/howto/creator-autotest.qdoc
index 8500c1c1282..a394dcc62f2 100644
--- a/doc/src/howto/creator-autotest.qdoc
+++ b/doc/src/howto/creator-autotest.qdoc
@@ -35,6 +35,8 @@
\title Running Autotests
+ \commercial
+
\QC integrates the \l{Qt Test} framework for unit testing Qt based
applications and libraries (commercial only). You can use \QC to build and
run autotests for your projects.
diff --git a/doc/src/overview/creator-commercial-overview.qdoc b/doc/src/overview/creator-commercial-overview.qdoc
index 3665d5c095a..f21189d373c 100644
--- a/doc/src/overview/creator-commercial-overview.qdoc
+++ b/doc/src/overview/creator-commercial-overview.qdoc
@@ -28,6 +28,8 @@
\title Qt Creator Commercial Features
+ \commercial
+
You can use the following \QC features if you have the appropriate
\l{http://qt.io/licensing/}{Qt license}:
diff --git a/doc/src/qtquick/qtquick-connection-editor.qdoc b/doc/src/qtquick/qtquick-connection-editor.qdoc
index 6fb08767e2c..2d3aa49ccf6 100644
--- a/doc/src/qtquick/qtquick-connection-editor.qdoc
+++ b/doc/src/qtquick/qtquick-connection-editor.qdoc
@@ -35,6 +35,8 @@
\title Adding Connections
+ \commercial
+
You can use the \uicontrol {Connections} view (commercial only) to:
\list
diff --git a/doc/src/qtquick/qtquick-designer-extensions.qdoc b/doc/src/qtquick/qtquick-designer-extensions.qdoc
index 0ff8231c7a5..127a1860425 100644
--- a/doc/src/qtquick/qtquick-designer-extensions.qdoc
+++ b/doc/src/qtquick/qtquick-designer-extensions.qdoc
@@ -35,6 +35,8 @@
\title Using Qt Quick Designer Extensions
+ \commercial
+
\image qmldesigner-extensions.png
\QMLD contains commercial features that make developing Qt Quick
diff --git a/doc/src/qtquick/qtquick-pathview-editor.qdoc b/doc/src/qtquick/qtquick-pathview-editor.qdoc
index d65310f9adb..4e15cb0424a 100644
--- a/doc/src/qtquick/qtquick-pathview-editor.qdoc
+++ b/doc/src/qtquick/qtquick-pathview-editor.qdoc
@@ -35,6 +35,8 @@
\title Editing PathView Properties
+ \commercial
+
A \l{PathView} lays out data provided by data models on a \l{Path}.
A graphical spline editor enables you to specify PathView paths, which
--
GitLab