From 26d33081187c5b2865cfd2431202cacfde54c081 Mon Sep 17 00:00:00 2001
From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
Date: Wed, 19 Aug 2015 12:30:48 +0200
Subject: [PATCH] Doc: reorganize and rename docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
- Move general docs to src/webengine/doc/src
- Remove a dedicated .qdocconf for Qt WebEngine Core,
build its documentation as part of Qt WebEngine
- Describe all Qt WebEngine modules on the Qt WebEngine
index and overview pages
- Add a wireframe drawing on the architecture
Change-Id: Ib4261d1a16bbaf313d0f858515184a96dab524a5
Reviewed-by: Topi Reiniö <topi.reinio@digia.com>
---
src/core/core_module.pro | 2 -
src/core/doc/qtwebenginecore.qdocconf | 32 ----
...necore.qdoc => qtwebenginecore-index.qdoc} | 37 ++--
src/core/doc/src/qtwebenginecore-module.qdoc | 44 +++++
.../doc/images/qtwebengine-architecture.png | Bin 0 -> 11325 bytes
src/webengine/doc/qtwebengine.qdocconf | 40 +++-
...bengine.qdoc => qtwebengine-examples.qdoc} | 19 +-
src/webengine/doc/src/qtwebengine-index.qdoc | 89 +++++++++
.../doc/src/qtwebengine-overview.qdoc | 171 ++++++++++++++++++
.../doc/src/qtwebengine-qmlmodule.qdoc | 39 ++++
...ngineview_lgpl.qdoc => webengineview.qdoc} | 48 -----
.../doc/qtwebenginewidgets.qdocconf | 6 +-
.../doc/src/qtwebenginewidgets-examples.qdoc | 38 ++++
...ets.qdoc => qtwebenginewidgets-index.qdoc} | 84 ++-------
.../doc/src/qtwebenginewidgets-module.qdoc | 43 +++++
.../doc/src/qwebenginepage_lgpl.qdoc | 2 +-
.../doc/src/qwebengineview_lgpl.qdoc | 14 +-
17 files changed, 508 insertions(+), 200 deletions(-)
delete mode 100644 src/core/doc/qtwebenginecore.qdocconf
rename src/core/doc/src/{qtwebenginecore.qdoc => qtwebenginecore-index.qdoc} (86%)
create mode 100644 src/core/doc/src/qtwebenginecore-module.qdoc
create mode 100644 src/webengine/doc/images/qtwebengine-architecture.png
rename src/webengine/doc/src/{qtwebengine.qdoc => qtwebengine-examples.qdoc} (81%)
create mode 100644 src/webengine/doc/src/qtwebengine-index.qdoc
create mode 100644 src/webengine/doc/src/qtwebengine-overview.qdoc
create mode 100644 src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
rename src/webengine/doc/src/{qquickwebengineview_lgpl.qdoc => webengineview.qdoc} (92%)
create mode 100644 src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
rename src/webenginewidgets/doc/src/{qtwebenginewidgets.qdoc => qtwebenginewidgets-index.qdoc} (58%)
create mode 100644 src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
diff --git a/src/core/core_module.pro b/src/core/core_module.pro
index 291aac916..c23fc235b 100644
--- a/src/core/core_module.pro
+++ b/src/core/core_module.pro
@@ -9,8 +9,6 @@ QMAKE_INFO_PLIST = Info_mac.plist
error("Could not find the linking information that gyp should have generated.")
}
-QMAKE_DOCS = $$PWD/doc/qtwebenginecore.qdocconf
-
load(qt_module)
api_library_name = qtwebenginecoreapi
diff --git a/src/core/doc/qtwebenginecore.qdocconf b/src/core/doc/qtwebenginecore.qdocconf
deleted file mode 100644
index 491447706..000000000
--- a/src/core/doc/qtwebenginecore.qdocconf
+++ /dev/null
@@ -1,32 +0,0 @@
-include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
-
-project = QtWebEngineCore
-description = Qt WebEngineCore Reference Documentation
-version = $QT_VERSION
-
-qhp.projects = QtWebEngineCore
-
-qhp.QtWebEngineCore.file = qtwebenginecore.qhp
-qhp.QtWebEngineCore.namespace = org.qt-project.qtwebenginecore.$QT_VERSION_TAG
-qhp.QtWebEngineCore.virtualFolder = qtwebenginecore
-qhp.QtWebEngineCore.indexTitle = Qt WebEngine Core
-qhp.QtWebEngineCore.indexRoot =
-
-qhp.QtWebEngineCore.filterAttributes = qtwebenginecore $QT_VERSION qtrefdoc
-qhp.QtWebEngineCore.customFilters.Qt.name = QtWebEngineCore $QT_VERSION
-qhp.QtWebEngineCore.customFilters.Qt.filterAttributes = qtwebenginecore $QT_VERSION
-qhp.QtWebEngineCore.subprojects = classes
-qhp.QtWebEngineCore.subprojects.classes.title = C++ Classes
-qhp.QtWebEngineCore.subprojects.classes.indexTitle = Qt WebEngine Core C++ Classes
-qhp.QtWebEngineCore.subprojects.classes.selectors = class fake:headerfile
-qhp.QtWebEngineCore.subprojects.classes.sortPages = true
-
-depends += qtcore qtdoc qmake
-
-headerdirs += ../api
-sourcedirs += ../api src
-
-exampledirs += snippets
-
-navigation.landingpage = "Qt WebEngine Core"
-navigation.cppclassespage = "Qt WebEngine Core C++ Class Types"
diff --git a/src/core/doc/src/qtwebenginecore.qdoc b/src/core/doc/src/qtwebenginecore-index.qdoc
similarity index 86%
rename from src/core/doc/src/qtwebenginecore.qdoc
rename to src/core/doc/src/qtwebenginecore-index.qdoc
index a690d3f0e..49231c8f2 100644
--- a/src/core/doc/src/qtwebenginecore.qdoc
+++ b/src/core/doc/src/qtwebenginecore-index.qdoc
@@ -25,35 +25,40 @@
**
****************************************************************************/
-
/*!
- \module QtWebEngineCore
- \title Qt WebEngine Core C++ Classes
- \brief Provides public API shared by both QtWebEngine and QtWebEngineWidgets
- \since 5.6
+ \page qtwebenginecore-index.html
+ \title Qt WebEngine Core
+ \ingroup modules
+
+ \brief Provides common API shared by Qt WebEngine and Qt WebEngine Widgets.
+
+ Qt WebEngine Core provides API shared by \l {Qt WebEngine} and \l {Qt WebEngine Widgets}.
+
+ \section1 Getting Started
To include the definitions of the module's classes, use the
following directive:
\snippet qtwebenginecore_build_snippet.qdoc 1
- If you use qmake to build your projects, Qt WebEngine Core is usually
- indirectly included through the \l[QtWebEngine]{Qt WebEngine} or
- \l[QtWebEngineWidgets]{Qt WebEngine Widgets} modules.
-*/
+ To link against the module, add this line to your qmake project file:
-/*!
- \page qtwebenginecore-index.html
- \title Qt WebEngine Core
- \ingroup modules
+ \snippet qtwebenginecore_build_snippet.qdoc 0
+
+ \section1 Articles and Guides
- \brief Common API shared by both Qt WebEngine and Qt WebEngine Widgets.
+ \list
+ \li \l{Qt WebEngine Overview}
+ \endlist
- Qt WebEngine Core provides API shared by both Qt WebEngine and
- Qt WebEngine Widgets.
+ \section1 API Reference
+ \list
+ \li \l{Qt WebEngine Core C++ Classes}
+ \endlist
\section1 License Information
+
This is a snapshot of the integration of Chromium into Qt.
Qt Commercial Edition licensees that wish to distribute applications that
diff --git a/src/core/doc/src/qtwebenginecore-module.qdoc b/src/core/doc/src/qtwebenginecore-module.qdoc
new file mode 100644
index 000000000..750a0244e
--- /dev/null
+++ b/src/core/doc/src/qtwebenginecore-module.qdoc
@@ -0,0 +1,44 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+/*!
+ \module QtWebEngineCore
+ \title Qt WebEngine Core C++ Classes
+ \brief Provides public API shared by both QtWebEngine and QtWebEngineWidgets
+ \since 5.6
+ \ingroup qtwebengine-modules
+
+ To include the definitions of the module's classes, use the
+ following directive:
+
+ \snippet qtwebenginecore_build_snippet.qdoc 1
+
+ If you use qmake to build your projects, Qt WebEngine Core is usually
+ indirectly included through the \l[QtWebEngine]{Qt WebEngine} or
+ \l[QtWebEngineWidgets]{Qt WebEngine Widgets} modules.
+*/
diff --git a/src/webengine/doc/images/qtwebengine-architecture.png b/src/webengine/doc/images/qtwebengine-architecture.png
new file mode 100644
index 0000000000000000000000000000000000000000..37ca2da16dbe915910e2a82422375d803da1c6bc
GIT binary patch
literal 11325
zcmbt)1ymf%_vYY11{gF94iN|zECjbf5<C!sYjAh>022rr5(orOkOX%d++J{Z2@u?2
zaM>Q-d%xYYyZ_xiXZswOo|>xe>f2TKe&2WRdsSsQFdh^S1OkCy$irTNK<G8VdD%T|
z;D3I5gAwq7>nN}70s;}XqyEr7u@O=OjX16^lw@!g?hz2s^LK5uUEDRvXt_$dxmr3n
zgYt`d<$)#wSD*=I=3?q><>+eVU=Je2Wn>20@lfs34vt>VRu-17paP;^A)uA;uGQJh
z7}b@*)ymEc#D7YJ3;cqM`bFKr+||R_*$kxbc#G<ee|K>!7gJkfpsO>ey160-XugMP
zeq-!xZ)I-*YNlQd2ikD{9`ELCY6e2yhHU-YP1?cE&dlBwbkh5|324Jcb<?nNwKW6f
z?G8T%ffzt9V3Hc1Uw7sl;LEEBuKm5;)ZK{foNQ|Wi`kE3&qcS4%al0PErmJVGjQ=A
z6IkIk`f<BFt>Bt|6Xb+Xc{&yvFa5ij8^^nI@F>Rt`V`q9A3jV`PANqKR}y`}D8@I}
zOSNOgH(fzjmu(q8moc|Hhv0hP^FX`m;VsqempvSGZ3XXRd1ldzjUkm7Wl`TVVi@We
zSvt;RlR%yE$rCufhr{8PKYEW#2wb4RDcmwa*)6%7PLByVlArwh`_tx!!1t{DR!}0U
zQw|=+|8Iw1y?;-lEyLL7ambGi@z)Wy45E*TnxL|TUazHnoiKV@jUqHg$zIB)yf>lP
z8frJvgpo#~aY7(Nd`I|aA7~D(vA>t=YC+`G3mb85<hhEZoUgSc^FK?^AE(GZ##JW+
zCaMf|0z09p60&6%{T2AIghUBsPW3V+%|?i7GDHCeb6x6=#RTPG(^{UmZeCK6ZR)si
zdO$<Qgd;2|R9#fJ4NcWNxJv2?s1D?9ps-UUnG+*ZwoWlf-pGtKQfp9&bd@nP7=tu$
zFq54*yuq7n@$$Q^=hns!c&~vL)T>119x+I3R(JBIdSjFqy9TiM<7n(TOor~XMG82V
zy>@Nc>LWa1DzZhwX|hWA*%E~&rVkZ=h+WIC;!0;zQZ4Q2eatwy9vt16upe<SZ&qrt
zzUJ8wLMr?|U&HjWZEsqvkK_r~R4aYipsMd_?tzBH1>Wv+gu<SmvUKGm`;j@StrVK?
zI7g^fPC{AnP`Cfkm@YkrX;L0F-;MXf4gBhX&oNU{NrWpO8p6Q#WE|bGkGby=qhz_a
zLZ6Zbn1RCWxGF+hC4<65)FdmMW*YCMH5T!N9#=(e&u|ICFo<l*akNj_?rFs2vzbv+
z+yZvHDM`=3ou{W6%t2UdCz09(TvIJJz|$uNoh&v6sCGshgc<L))#!#BkK<^I47HPn
z-fJ(1d=)<uWPkZW#EbF$ml2DwGS0LZSSsz>`SVx6T1bcB=*6@~@sM@H2fT-I-+9Ti
zm`s37P8x=_yF{Yt7G;|$PBAS?r!b8yuM4|kv|*W=w&&UrwnlRwtrws46c|k$vo3s@
z1_`@m>(ip!$&qmLhri-jOE(#^6GECXpzRi_obLae(<_hDx~K<c<3b$T%@FZ885*V?
z?&LvVy|*zr)WfpCz7#rn>a;P$MQBSaLjOKkF#5=e{rQnBwO~4j=uc2aX5B}rv0ONV
zX#RyhxL@Pl$%U@U$2}H2KSyl9V^C2F5!#H~2^VNY?W7XCtkiIs9*U9y3=`9cF<V_>
zxQNhoP_)RF;4{i1w!%(U5kJx6z3(Tb*E+U-dcm2##;oSpCPv>C54<W@A}=IM;xT-7
zLaS2WM-QhWE%TtkF<f?2X2u(Pijb-&Qdg_$_In;{0*zqLT&{ZY#jh4W)4jFl4b?Gw
zoPWHyA8xjE$gLjCeHXdu${$#)7VsZ_qYXUL1#kC}Q^6FX+FR6OEv404Z~or8x0(3T
z0`i-*mS{bOo=Vd@ObSdDMBr+V6(uI0kBjcA)w+{#!PUx1k6Vgz3zBAWe2=B(U`W{W
z2A@mGqMu}l+uQv{_-U_DLd^WGl^5_@Lq_(_pW{M<G+xhDgy+3vpo`1Q`;whOsTpI^
zxO!8_VNA|8&-3A{Pg0>|L9PSO=QWbSEvl}G!3M5eZKUfQrbOF`@-I4are^p1wc~bW
zE*@O>&~nrby<e);+%D4j|GW}5fcvFWs%N2jIsFblJEy-9;1o>`f9fK(?+iR6cJaiK
zlk+5+4gx;xkG>&DH9U(w+?}!biw!J*ZD&KpvlNH<qrcPyrzEZMy>>wxG@h+^8hP08
zbyZhIPRwOuhj`nqCP#P}TBnrT_|^Mt-+0oDuCYD<yxGOyP_y4=Jo<jUz3wD8-Q=W~
zrt##g8l9`{D9-Y^w;=ud^~tZBe5JW$q12r-HSGSC)tkg>x-scZ!9)&*M3n>sa#_FE
z|M))0Iv7+B^x0AeQ_|yJR6T%TkqdfIA%z8`IR0}bOOa!;MX1LX@qn|UQkG=>S+|J2
zUmc}26=2}Dp`LSj*m7nrXrdv&=jF%U_m7AM<N)Vg9pwMRgN%$nG=A!WpVUu0L`pw|
z?11oX;hq1D?eHdJ8FQAXE)KgdxboU=-{BclFk$hO|4YfXoiian&pKCw>(K6=<F}>x
ziIWM}2mYm@b==M;B_d$Ec^*O+F)WVq?3X1cZM;qM!;jo@^H{qaW$F5hHA0Kj1wuGu
z;Om}>zJYAGJVx7IjbiBQIblgjfhHOm1BF$-UtlC=ARf)nRnhgop8515EYmwCDXsVR
zA4McfWopu8|CS|To}J+P0u`_yFCC!~>z;)fKMvJ@lX3sp7f;<>pvzbBa=t<b&9ZU1
z&rIBNo@D6l=9Yr_vP81dg|FcEV14P%&?zr@bE=4Pi;>X`>CV<|vW5gx`>YI2;z;{S
zy#&)Ca68r-!#wPx%)-D_P@aXYqA~eK2Y)la{N?&DnnFy?EZpXqeh4Jhk#r$s>*i}3
z?Fy9{ixi0yH`+F({zCjXQO_WwG)bU)%mQ=+Oo0j)Pq+QwTK1_I){oqu{j<oT-|8<?
zj1ibD<-f4&=X7Hq>E_9oNB=n!-^MPdM=PyIiiETfA%qGCX6&w;b6_477CSn(`8imo
zdqrP-^_wEi_E7i->$wYOMdqgmVr6c7x#NFKOtA32#yIaZ#ni4|M0Ltwjn!eZ4x2A}
z7?V4d!iSBqi1}`h^3!=bFt1{?*Bm6Li9BE3o1M;m6>1bfH#XH@IbM0~kUGP&cNG<2
zfyR&1Vems;SO&(2_mO^)DF_R~@<k4<$o~z-y9W=1V+)^gX=!evw^vpfDwIMmF*QFw
zEAUFL^)4F_nW{R{qU2;~tTDra{~ggvf{tgO3@bR#d>wUNmNM2d)MjnjTgsH=t}qYW
zQ&6N?cw_ASZM4VkM9tLDIuH8dTVh$?4l3ApoA~{8ld@}}s>(Y_@wKJKLJ$b7I$<Ps
z+oU$P9jo_eqrZbxbWF-|B{-zto9hnbHuh}q%vuTV?F5!E003f5pm;pM(Q;RNW~?pB
zGPbHWpq6O~@Q9G<)BqSPoBx0nFVIhohrgb3kWkN@v~k3hw9ks8S4ktPQ=rZ+Ywi0d
zhNI`+5y{}j|3pRanh6BX9N~CMJNtOzwEoq$o{4dpI!D8$<wK_GZDtRyickI|9+)|r
z$q|*}gZ6^l?~`~xbpUZ^<+QQub1mi5%1)tNInA8N0WXKOlB(l=Xl)B-b=0h>6Nj%O
zRUXID+H9x$8a-r)MM;u~vp~)jSg5rTW|D0|ypB%FA>^YKI~ye-y*0T(F@29f()eOA
zYGLS9P7W$@Pl<44wxJTeJ`l)9c)nnQb?tB8n3>1dnVV-fZtQiT<c!TC82$vTsh|9A
z>~QV}FNgpkTF_pV#-Yu}rwq}<0k;(MuNoGPhjTZ7mn?PohUjv|2kdS2{oy;I^j;>s
zN|T;}c}m5QM9K^fo3_fR)HEgtB&s_Bvj&&_o_kTD)!G7{*ht9)cb?OqgDS{dy2w>L
z!qh7+Y)zf^6J_l0IzP^BE;EMlmdJUH{NBC(mZ({H>yTnd{WeYVa6^(DKu<><W2wtY
z&A*nQKZFY@{khhbEs~N0{CT3nL0v)L<5a}6c>F%^oM=c01bMoG>#YfA${G8M(TJ`o
z8#tJml0`-!i_?_f=IWuYe1{HmBR|5)*MmKhbtlpi1CRK|sr})c|3g5WUak5I{+{PY
z*f<YN=i^+xU?W$cWg%CmtIr2p`>Yke3LE>2dHD)rz?d@Y=2$pkA3|jeX1hK!NC$__
zNrQXrh8+{y@E8iPh|a>)%<<Drr==s_ma_kfC5&XrPl3}edyW-(W7_w?;g1FY8)@$8
zZIqyQ*!nrKJWBzc^yFPAx>$XbGD5n(OX^Y<Sa;9ds#6+bH<7(`{x<dCn>XaO>DcMR
ziXFc#lN~=yLFER7d=w?-Ob+3hs3yN|m*mOg<=_nCHylzPCx;{VQL$4kk215@EQJf(
ze($Yn2Xt61!y5GJfg+c$gIQg)T6r7z`vRPkwtaP+VW&bk04LY(I;6sEG%+Rp3bHrn
zjUgc37!8~|jgB!U%g4EJ>s@S<130W*>~yTTM@cCV-<WRLe@eVdGb#KnMPb9FvSd_A
z#3%WwYuS=(9{D5mq5Ci8`y?ST^CIqjBQ>$!-iCz&pXWsD`yyi&CWfK44Lh6c1x&Pa
z(gsSIjuWDXf&58`4>g8+vAp`3ZH?<f1E6)cF4O7NNC8^!3LVa0CkoH*k!VdK=G{2n
z8o{y|`s|E46a^25&Dgo@K>$v6Hxey7T}g8n#%}#&m5atNPLXY_%i&)0#Ts+4e-z_1
zkyQU`IzDLg)vbgb6>{k&#K%+J2aEnbzlhs`wg{4FU}-qpkjAYN{^-?pbZ`p2p&W9c
zcnP6fyd2si-rT#vtDl&X1ri9tB2yzD*YUaC7MXog*QD{F&yFFA0I%;#8*uFCue)kK
zm#$N2#yYS3(g`U{)ZlYD)#)i+vuTttZ#vc(U~nj4L?m?xId|8u62-1En3r;Ds{SyG
zEf%i!0&jdb^*^5a{qX)C@e6RNJW0K=!CRa8ci&>)pxMyd85@g-zC!pYXOC^^r$rO_
zeFXtG8n<xi7CszKL2XCT%ddxNDmyXPi)O#H40@L`KHJbulv+}7^G{SYHm>=((9FK<
zxr)l=dsxZy?jWgtLR?-~_P74!hzeux*DjC5!|Wowq4vnHk&MoqVa2{TDV}RwO`Si5
z#XC1Y1?<+%=7$r}hv`qWB`(xO(2E}FsF0`X01%wKjS4LYyK5FEiKQu<aC#p$d9?K)
zJtiVKNK9aok}+Iu6=tlvN^){lcm5Z>(@xWENDIeMY(w3VDGJqJPrBp^^$CzKFVeBO
zkcR5~Iucab;;tpLx<$i<5?vTmEw1CLGgHv|G6;R(=^~ja%RKYD7C3WWq0TPC9vZ!H
zUP(bU=&z-uk%cZVb^BD(#p#;#bHxswS$)7@FJSB&B85+W2EVvI0k_}Y1Vq(AVd`wo
zyF8m7zT#j0w1TQB0shzkQv7V{Z53^qRl-4Cb3uz0=dykK2ufkRD$;vdUEkkDhV{Rv
zygXupH76EkF`iw4g&7(>nJzj`CPHCVrH1hM&Lz_NasRIFO%lgzfBIkdF`2_j%1rk?
zl0a=2)C4cN0(y#eUfE0mFy=2?+Q>Hx0~x9l+fJFOTtY(P*bpQ3*}$C;r12NRKlf6*
z@ChwOcQ7j#OQ{DPqvxV$7_eszM-#d4IZ_+Wy)-hj+G2UmFQ7L0!noQ?N_*sYvO#BS
zje%lrm_<{19&*O;#gTtd#3R+oCbL2J{7Tywv1r-IqoKNd#z&863@L<lCW3I~mxyIg
z?^`kq{*^a_E7WQ#@RgCSzH!C~Yt$>98W&m+m&>w#DR>DxK5oGK3D9XYq~e;eAX66F
zR<3@$`Nvq*mLdz^ss9e9Hj>_24>BHYdGisAxOb%@D<wQnAA)D$K8|d8<NWe*&#bVb
z9KO?Qf}8^9&M|hbkzO!Uaj3Ju`}pO0?m>5MCUS@<us(%lw7{XOIwjXdFiMU~TSD~Z
z-o8KK#5IeItO&rh9Ym~8#2Rrm%`d$}=L~s%h{eRr{?T<i*=*3)-<-NHKnWTpJG?wu
z=s)*Kv3vZSPNpt~l(j7A*tVmRDCM%)$w2nw<ZEI2)A_FA!Y)4uB@@pNw}CaM)PSC<
zPeenUxXA-fOuB1l`rttQ$Jqoj@=TnM0<W0}6+uy^`y~XlWm_XPA=dQ4R9)`D-fgCo
zNr9$slEU9bAh-}apO#m@nF_BN5;<H*Pk6i6=P2#-J5-?A2i7-D+M=uWsAj$Yy*7Sv
z#TZlZmtpXSB$jMz%f2ol&1DcvU$b6_J$n2#7ROc~1^`bqz5Wpb#P$=sYnMfWdekBT
zfxuX%BvB2(K?QcD%DzpcKaSo{=l9wp@v58n(%l3$8-}X-C98hAh`xz4h@S(eGY1q1
z5;w-7yzRTcp8t-~?QwcFz+fou?P^UcEXZQA99)q3gCa)knbAt@8(x-Fx9x?`)LD2h
zD+vyB%8e&f`Qzoe%yuN6!P4~e+*xP5zk;-ggW|o&9;|!tOUO%=g#`Ur&e0d(mk_yd
zp3ImIFX=2y&7j+#O#NUwF<XA4+~?UkW5B2?Jn@RCK9%jBrfA)G`3%2O(zeaKr8-$J
z;#teLMDl%t)RKtfVTy6TTbqR$w$xAhG1SoWmzt&+%>ZPw<r9+gnCv?QutGNOIx=hP
zq0pWP8)S-G#o>=uOh!QiYf?%cRDyl8W`;5Z@ouE57lbm0NbsoOpgYz=fZU&5NjY@<
zerFU`>%4{0e;QxLEE;IO5GDD<L@jrz-pfQAm$~gQZ5JB0a~<K6*2yfM4Y!jMW<*}R
zSVgN)DAn#dAOJ^XYB!xLjwtcvf{XktZ51G)I(S~`w|JMkDP2xBkMnRu+#fGaRvx8w
z@V`;~ZC@N*;Ub1CIeK5nAS@wTuRrqWDp>%V>kBPu`ux<UGT!UU+sjR7N&r^Wt}ch6
zcF?-Wv20nRU-cv061r0f*;(oa+@o04_9C=)=;JZ%Q<3qeov^<MRHN6`qZ#N^VJ9ur
zr?wup&(Q7{islx&9kB9tpM*{s8c1%^yiJop9v93MdE|dii5?P)4m!PWf2y0iAtwO)
zsU?e5pQA!mB<J5U&Z{BCZ0JPZ6C8%2-ig&>0o_ii?W~ZjB<gd+3Wzhintl)Zl+&_Y
zI#b*Gw5#Y&Md1)G3qlGu`3-7uN(kdzvRc-=bGBF3?C{&Q7JFrb9Yehq<OU0;F@-b7
z|D0)THOm>5>^lDN;NRNS1oqLd=c+w}eVy4JYb}|z!8W<sAE$=$_^Mm#n}QQY(%1&9
zGwR0Jwr}v>tS!!vyWeVCL1u)h60GxAi$BK4@KO0jUow29%<u<i>64IX5pVm-jPx6m
z`Q{iC)y3KxoN)lV65G^u2Q#$Obi!<<Yd1qK*wSjPt}=11xFfaL>Z4yDwNoJ5Kfo>c
zRx*!96J)&O32jJocI1d>kQR8Nsv5>wASs28Z$dcMhDV{u@GSA39>sP&uZ2Sbvi|fy
zJ<+-Dz5&sjQ}56j!{3`UzV+Ty0X&~6t4nNe71Y#O1f9z*VZGU3cN@Xq^vlrUcOcaH
z{(nFyzu(iHHlq(^sTr}J+jWX_r8C3*=i3U249IPFrIcBld3ZRk0>gZ~Pd327L$CTD
zxe5p5tm)O2c=xtoZPU=Y5Y^|HM?Hkg62ECLI)cO`!3w_gjA$?aVVh{8_UL8&W!2+9
z`<sp=#|@E*S@34@dQ2fTq?Z?d9WHDC=Jt<jh?|pp8E5y26W4<hhBKOMcO3;4L=y-0
z2xo^m>0n<3TlkP5*qrM19%>bY@U^-Jw=R`#@#J^e$GR&!MtgGC+&Q&jeutIi#g{JB
zT98yj){mtPH9^lKG#!4Fgng21Qe!J%ntNyjHq0TwC1>dz>QU3&%~<vNV9GBMk?e#Z
z&dy_9vDsZX_TF7zkR=SQ3)6Cm-C6uoQGE1di7DfGn3PpPt_Ru{xo1G-xL1d6V|9N}
z6<hm4=1?FY@A%oQ34$M$Fl8WXxTqXyPVdwpeN(TCri$OX?#=kRTsyB6rraB|_P{Am
ziT)~(u=?^W@5DGzc1l^*Qp7#gEp^mXKwfyF=8MyIPiNl;9bC-;`-uwNrq!qp1@nKQ
zm9t1P3R)p><sGXIUy`@Q&AeR@ZFQ+;{~Prc&ED^N`sk#EEb>9=%x{^RqCc2`Xkd)R
zD(4@C%rSo<GvGDQvPte6;KpSrD-tg;He`u4RkVw&*wp%A5i2krYtU;#E4ZS6bi}=t
z;U>JxI30k)AKGAjy>dDnmU8Mab!`G|(6?5vifu-Z$iuTK6tH#YG$k(-Z~<0$^ybt>
zeB{HkQsFuv{<N4*Ah;eKPJ##f&&S)i3GFAm@$`$V=5k_c)rsiE2<m(P1#Z(%H<uOE
zcn8-WnT9K40gNtUqkd4a+dWjYDf-fvCOL2+pPuq@qkeMiQNH1br`X}7C{@=kU->|}
zdg>~bSA-OC={l|$B>b;gSmx(L->M;Rf+d=tu1ktr?n7FF+&d%#x%q9TiCw!do>H*l
z@iDbN86FayU?v918O9}RjMVAFvYU_IKO&ErBQ4AYd8{5&%?3CU@#YQ?)QP#y0=_x-
z0G2+!bI8rVmhDnt4dr^g?wiHhW_sGb$tojB#`LuJB4bO+b!o0Kclqjz;~vS8?*nMG
zLBAXmln8-UW3gs5J4f%T4_9tTN!RQ8E?4|cCv1&*$nn@&EKQvG_X)z-w<-|cy3X2+
zVD~2%_)v|bPnktp>@U|cTicWQ`S-az9}VJbOd=g37`Ooat0;J$zntWX-su}mA3Vo&
z|7}5EqfyVqmwXbZ^s{aKl2|H+zMP}~5fIg0n#gex<!i!@ZzQQADM|F#wpg1*17xKR
zhoME+8@UK}WtiCfs6mT5WqJpowMuhz0V3eOw<vuR->C?J3;i!S-yc$ZmPlbdcfu#0
ztHa`Msnu&vz>RzBe)@Ub>J-Zm$L)l)LB*b0d&=(m4_}~W{QNpChKuv<!RkDlr_wdm
zrbogqKCzlywb)#n?ljl_&)Z+d$X`7{vf#}P1@ov|?!AROWPi>}l6KpwKy2P0&Jno|
zs|RFK)YNcf!5g_Z--}(~fVdoh?IniZjJnEvp}_qW66D4b^O5JF6p3MC(++{Xu>W5L
z#h~inbJsR30b1>-ry?yklv<fJGthfKjS^n%{hetA#BZ4A>yg-Lb!WB%qB8!TVkB4s
z+edNmF!M7sPNOKwGv(_ERiax`;IRS7-S%0*m8tiuScpQ5KO|Ai2TLL5+H{?!i2*gv
zg=UQz0`54#L?umNu&!^Wfip)6=67F~;ix1K1foQKmr{Z8y}rLl0(>9RFb)KAIxv`e
z=>OcoJnZ%Uj*rm1IE(4+2z3oI-#mb0HKt96_U=0H?%MnBz8n#U3igURQ<V<*xn<Dn
zP@RR-0sXUm%kM4Q)2bNAo9xE*)BsAWxpDw@BHgvg9{=AdF(W^-BSM1m=xY@RiSu<k
zki_8uzpvHqIfD$%Kw|Hv2icY8xd$r4@qnw4JLzsrGoaRnABM|}IxI9F-R_g5CFyVS
zUG8Jdo)Z1ayE#v+xoG#GnnXR5+5m8YhLe_o5|)Ptp9TWT=WN@+jsd5?f2xWX{q6{*
zmr4?(uVP0r7pBBZqTS!q>HZNe>E|?QskhM!?6erOjk0Q<w;2S;WvFKH6>o?xswWf<
zq*?Y`|Ijb)-qwdK_?=m=|M4Mo-0~nxaG*FS?6@7Vf!vwePV_c3(Xq|5{+vWdRTQVD
z>7tkh(AVjKoqVi=i87v=92e&maTDTz6xiWh`#hppHGA|4jCd~auaU^I=XYHg)&}HJ
zi)rub&qPq-25Yk)uzZVTn<jd)?(UNLfZk9V$<;(K8%ZtH%-<`tD_$coSgb^h8eQpf
z^8xd~7E?gHmd^5K5N-Do#|%gmQPr8;jYa4rkO29apj9yKqQB>*5S@6yL)Y)993|Y_
zZKM2+<IyrBauK>J1~caTxBX#SRCA3k5#OHTWUIriQrG!_d?uR=3={O!x%(%17ZJ}=
zB()ZW&KetIBsoMC5G7Zk!;wE7tHdt+u|olc6`&Vix0AB|)y?^a5Xva{E+aq0Q2^hu
zP)Fq~!=2xa3!M}Nzv94g%~#*s_IoSj54F60569lRqQV7|N_R7cn$u<x<La|A32i{p
zUZb-q=vor;SlVZmd~7XZlP}EprWu%r<O0Z?DUr}3p`#L*n;WeoPa@p~+Z;-$C_$1c
zxfe*IOKiE5n_1$(^Q{|uoK^t)PBlMi`pv+U%;4wuBN5KR;wNr_Q>|SiJ4m4!XP}3%
z`K1bxJ#0%t@?_FYsn}>D*2&nNE?zrqY5P4N|9WicQ{i_YkKr#VEP3SZS-NQk4h$4?
z5_*HGuLU3lG4J4(BB8r251H_agRN011k7r1>ysrD$ag>*vt-#OD+DPhF*Y@Y9cK~X
z1_J7_5ssNGRYWXIPZ4w}Lz4vBHjujps1?rxIj*<NshOGlg=o!lN@Ug@=8kK^D$P5U
z!}w)^$ss1U(4%kEHR^P4+nE8<*0(E(%wfS~E1z-S3^!YE)k&$qq3UtbmN#jgliqp3
z7T18-sbu1Wz17$v*Ag8VUl1G=d&~qy2YdvdFPgW8=|7S&K$Ub4RVZN@Z|SgVfK(lE
zeC)PFmA4iejBP;^;5K?T*dv-5SnZV61#)};urk6LfR$~D7_(SI4mvmr?zz*B5>#Pr
z9W;^83VBzgNWNWjb9+*L>29q`0482JVWlu>^&>TzU|Yqj;8hL_cLHh_u28iA-6{Q7
z=HS=N?~h+qY1<F_DZ}^(6xA5Ae)FE9iye+<q}-?j%C@j-)v7u{-$kEAvVE3d-;~d6
zFB`dLT=b)iiO9Y*RS?Hf0c_>7ml1_p-uKwk^Wu_X!8O-U7T>kCYFnNPsPPACjSgjV
zm}4Lm$E$iJW~|m8;Y(sDf@dx@i+0uKNVMKR0s)k#YvI@27PW6WDFlq+<M`f^=U$ZF
z%xiXhU|msBVy0W=8BHXV4kno=WCHYL#)rLES_)E+O>Bet!D8-6>$WOnceO6K>Fw&1
zfhikn6zOtOk)Tdd0)+|71HyXj4uLQ<M7yPEs?M;0hpniBctWHt4<Dj-52z@xJOh%r
z>ohgmvtH%9JScFlr#sT$ME(!B$1bD*kEN3R5bL1B`Vk!{=!$4_`a?pbQN2@9rN(`!
z7m!O9-t5N61f{!sx4{IsP<JAJ_G&MYA{53il-@VRYO43(U$<OYsLOp##5Rbv$7kc+
zm07Hqad1Z0?}eVL`EF#GS?H;L6)BHN)`uUNl?1ipE4{UL^-V(T^fjC?SXO+MC@
zZoBTGHoxuOx7dZLclK-Fsu~b`kQ5~e0k)zm-8H@>GY!N@`va3ck+J@QwATYoy51o;
z&Hn98TT~Q%^*5^M_PKm1@7_|VA!+0Le$|GSn15Hf2Po%aNS@P-OQdIb0X}4?1gNdZ
zGGzp`PMM0Zy0TzBK(MBUXIp~t9~BsP9J%``7@4h2?<U&~<M!eue74ebEX<>tP*4N5
zIgl|`Dqf4ev0G8ivw`=4e`gZ{I}wGeFRcrTJ<zI0{HGMu5L_MnV(pB~bozEVeCz`c
zGwM58s>E9vi`>>z!Hom&;bB2Qae%9>3E;j4R%465>pV`DA+z>5DbdEY(JJxA_G&wL
zmH00_Mf`B5vnMYUE&4Zeit9!&WQL=M5;LQ{8cciX#>ywn@k7Kv$H-Kd1e3k&^D~Z8
zR(&-jMpPSFG&6<LL#NyP1jV;F0iAROcfEss93@#W7Ef;-_@WgS*AYX&Eq6ks&f=fy
zBC)F>-ePdR5X?26)f)R^7Po(f4{*~)#PYDw&K?K-P}=acO+I>{+QZVeJ?rs<8bBq>
z`!16HsEY1dA&wur8V2(-i9m-8IgtW;Xt$Q`5<_!ZDtWn$1cHnLaKaD^T)Ti5h|5sC
z92Qi>`9Hvj|0~Y;f9~*ws^g^t00O2BZ@KLKeQD`w8igaC+})nr)8s?}{<Y~tE~i)|
zfQ=5c#=W-DcK-oq`=cEe2gq}WW#RH$_u1DBKs3)XJ!~-sBWLi6u1^CNah-7AWG_%(
z2*vO>qtgC0N7XU=K(60hIbE>-H7V)=?}>2Nzk6(+xL?`T6e@7yAH6VthHFrB6_QzW
zH0g|j0kdc8v?4(0zdwrtA*m7r{Q)>YImF@6jI{nhDOOEW@h!GOz-bJDJ*s?2x#Vmi
z0DnxpNodrKMmNysXnCvVc#5s7Qs@qBNdF77H-)14WdP;bUGFC|YTn!rdcTHy-JYmU
zv^f1!hxA|888M%0a6yJFEhp#y%CHvlCjoesUg+pmCMv+fs!N#Y0>E>f`M}Qo7y`W1
zR02S?u0#hSHBzwlygVyMHSZI|aJISZY3s!~N=>yH{RD)^=P2j9VewBQm~rQxJ=%XF
zU1m(4H&7v^wcYYCD?j(|OfB8fKdIViJ}i(2u+GR+BpnLAJW`d+|2sX4K>wM@A9;Up
z`=Na-AUB~^*1m65hP>j#&l6<n_cCW=*{;w{<dtdRGHW?V8SD`PDyfKoN~&aMD48?{
z<`iwS(0g1@ap~;Q9+dj04LZIiz_Z4lkz$ULlpd33LL`Vj86mWvYq7%i;*CUFF6HU{
zT{Z;$GtS#RQK<3mK6LAsB&3|f4R7=LxFn3PKPgKBrmoxusK3FpewsL}@ph{#FUw!Z
zy9@Sh6ww)?qJsaPTCpWM+YqJ^S?P{m(RV$Ghys2LrLAf__bAn|omZzV#UXIZuiQWh
z*db%88)my0qN!-Z9FUgQ1VF^Ax)`Q=B6j{;T}}o6bjxA|5>=q}9QUiAy9pGMFqm{3
zP&StH6_7wNa>o4=0GZsEBXl@}e#%4VF$4kzqfFop;E{N3*qA_I<)H;*0pt8u9y*}S
zpl2)~k4aK|26yOIB%KSxCHWv~_$a@BeJ2raWfNZZGgKUy@lqYEThnh~{!=j`$K{Ci
zuo4|^gK-u3F4f*xV>?5$txD%DKoC}1j9cOBZ;8vbD0edJH=`Fq`M)Jz;M&vv0eEt<
zltHEcp+A2iO6Vznp7%#Jj~oqjmthfTb|Z!;HQq7p%4Wdx_?=~27~mtaP{|U5&vz?&
zW7tM-U29h(_Z($+;P_vu$iFT^unP1BMRdJSsqRYftmpn=$ZoWm7_&zf4`v%F{YN_#
zVhmdPREok4qEV1GM-Iqab=OX+PC&$(uRpw-3Badc6mvTeZ1C7Z4)y?h6*6?}xi?Pj
zxw%xHnaI1h5C&Af3^rt9=&2=z81IG`jeewzPZIRQ-rF_AN3f#?C^Zrh+SHsMxcTlJ
zID{IE1I1aM&qyri0jLd7SEsEJ#Na3NKuXSA5RfvYZJNG*GkdiXBl-z=ufT5m4sdFl
z&4K-C9C7K3{D6)854!2rHD~fA#nNFn@l!bAmEjJ%h~T}efq<>=_MkwI)8gN!$c3lf
zC?X_;#<XUFnyRPlO>SDx+1PFq)5X+7fIWF-^d$D0w^H1+Z<9RRW63;ZXlUd+_04uh
z-4sTPvehp+hvjpw1~SW=v@qPux+}Yee8lj-jH2Nv(QtXAD~)<y!5p*?5GPWAmH0q8
zKcKA0k_RxQ%!@=rrt>qMMKf<aM+@cj7NF9~aYsdb$IJ=kwX!5oBsp=dG3dzRTXWCx
z)x+{!dLP0p;ugRWdvgS%u9H_NeuZ?qZ!UV=V+8>1Q|n`&v;7mdtKGIYm#kr^9^HS4
z0{m!Eb^}<_)8n$ta9oVRvgS(hYqHhr8B~=NQlt$1?zLUxobKnG-~mLElF}c=&#uh3
zo-0mDpzAe5XR5A@A%<y}*o}wh4pl!1Py^zM0aNn3*w=r1NTU*n4+1C!iks8lTnGVl
zvNbCK2GDao-?w7hfR_QvI)71_(*jjQ0GXo(OaZx^edEM`fneZDpfwDfF`91z|H-Z{
z%}!Kna>-s(xxC}k$0VWmnASL#%g$b-7?=6CcR@IR^KsLk#cHVXN;td|wRwT#zb+O1
bb&FG2F*#|ghtmmE$%0<UD8q`RjDr6gM-Xi(
literal 0
HcmV?d00001
diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf
index ad6898440..527983ca1 100644
--- a/src/webengine/doc/qtwebengine.qdocconf
+++ b/src/webengine/doc/qtwebengine.qdocconf
@@ -17,23 +17,49 @@ qhp.QtWebEngine.indexRoot =
qhp.QtWebEngine.filterAttributes = qtwebengine $QT_VERSION qtrefdoc
qhp.QtWebEngine.customFilters.Qt.name = QtWebEngine $QT_VERSION
qhp.QtWebEngine.customFilters.Qt.filterAttributes = qtwebengine $QT_VERSION
-qhp.QtWebEngine.subprojects = qmltypes examples
+
+qhp.QtWebEngine.subprojects = classes qmltypes examples
+
+qhp.QtWebEngine.subprojects.classes.title = C++ Classes
+qhp.QtWebEngine.subprojects.classes.indexTitle = Qt WebEngine C++ Classes
+qhp.QtWebEngine.subprojects.classes.selectors = class doc:headerfile
+qhp.QtWebEngine.subprojects.classes.sortPages = true
+
qhp.QtWebEngine.subprojects.qmltypes.title = QML Types
qhp.QtWebEngine.subprojects.qmltypes.indexTitle = Qt WebEngine QML Types
-qhp.QtWebEngine.subprojects.qmltypes.selectors = qmlclass
+qhp.QtWebEngine.subprojects.qmltypes.selectors = qmltype
qhp.QtWebEngine.subprojects.qmltypes.sortPages = true
+
qhp.QtWebEngine.subprojects.examples.title = Examples
qhp.QtWebEngine.subprojects.examples.indexTitle = Qt WebEngine Examples
-qhp.QtWebEngine.subprojects.examples.selectors = fake:example
+qhp.QtWebEngine.subprojects.examples.selectors = doc:example
qhp.QtWebEngine.subprojects.examples.sortPages = true
tagfile = ../../../doc/qtwebengine/qtwebengine.tags
-depends += qtcore qtgui qtquick qtquickcontrols qtdoc
+depends += qtcore \
+ qtgui \
+ qtqml \
+ qtquick \
+ qtquickcontrols \
+ qtdoc \
+ qtwebchannel \
+ qtwebenginewidgets
+
+headerdirs += . \
+ ../api \
+ ../../core/api
+
+sourcedirs += . \
+ ../api \
+ ../../core/api \
+ ../../core/doc/src
-headerdirs += . ../api
-sourcedirs += . ../api
-exampledirs += ../../../examples/webengine .
+exampledirs += . \
+ ../../../examples/webengine \
+ snippets \
+ ../../core/doc/snippets
navigation.landingpage = "Qt WebEngine"
+navigation.cppclassespage = "Qt WebEngine C++ Classes"
navigation.qmltypespage = "Qt WebEngine QML Types"
diff --git a/src/webengine/doc/src/qtwebengine.qdoc b/src/webengine/doc/src/qtwebengine-examples.qdoc
similarity index 81%
rename from src/webengine/doc/src/qtwebengine.qdoc
rename to src/webengine/doc/src/qtwebengine-examples.qdoc
index 8cd9b6367..ec49577e4 100644
--- a/src/webengine/doc/src/qtwebengine.qdoc
+++ b/src/webengine/doc/src/qtwebengine-examples.qdoc
@@ -23,22 +23,6 @@
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
-/*!
- \qmlmodule QtWebEngine 1.0
- \title Qt WebEngine QML Types
- \brief Provides QML types for rendering web content within a QML application
-
- The QML types can be imported into your application using the following
- import statement in your .qml file:
-
- \code
- import QtQuick 2.0
- import QtWebEngine 1.0
- \endcode
-
- \sa {Qt WebEngine Examples}
-*/
-
/*!
\group webengine-examples
\title Qt WebEngine Examples
@@ -49,5 +33,6 @@
from displaying Web pages within a QML user interface to an implementation of
a basic function Web browser.
- \sa {Qt WebEngine QML Types}
+ For widget-based applications, Qt provides an integrated Web browser component based on
+ Chromium, the popular open source browser engine.
*/
diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc
new file mode 100644
index 000000000..e6f071913
--- /dev/null
+++ b/src/webengine/doc/src/qtwebengine-index.qdoc
@@ -0,0 +1,89 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page qtwebengine-index.html
+ \title Qt WebEngine
+ \ingroup modules
+
+ \brief Provides functionality for rendering regions of dynamic web content.
+
+ \e {Qt WebEngine} provides functionality for rendering regions of dynamic web content.
+
+ The functionality in Qt WebEngine is divided into the following modules:
+
+ \annotatedlist qtwebengine-modules
+
+ For Qt Quick applications, Qt WebEngine provides the following QML modules:
+
+ \annotatedlist qtwebengine-qmlmodules
+
+ \section1 Getting Started
+
+ To include the definitions of the Qt WebEngineCore and Qt WebEngineWidgets modules' classes, use
+ the following directives:
+
+ \badcode
+ #include <QtWebEngineCore>
+ #include <QtWebEngineWidgets>
+ \endcode
+
+ To import the Qt WebEngine module's QML types, add the following import statement to your .qml
+ file:
+
+ \badcode
+ import QtWebEngine 1.2
+ \endcode
+
+ To link against the modules, add QT variables to your qmake .pro file:
+
+ \badcode
+ QT += webengine webenginecore webenginewidgets
+ \endcode
+
+ \section1 Articles and Guides
+
+ \list
+ \li \l{Qt WebEngine Overview}
+ \li \l{Porting from Qt WebKit to Qt WebEngine}
+ \endlist
+
+ \section1 Examples
+
+ \list
+ \li \l{Qt WebEngine Examples}
+ \li \l{Qt WebEngine Widgets Examples}
+ \endlist
+
+ \section1 API References
+
+ \list
+ \li \l{Qt WebEngine Core C++ Classes}
+ \li \l{Qt WebEngine Widgets C++ Classes}
+ \li \l{Qt WebEngine QML Types}
+ \endlist
+*/
diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc
new file mode 100644
index 000000000..81ae5b737
--- /dev/null
+++ b/src/webengine/doc/src/qtwebengine-overview.qdoc
@@ -0,0 +1,171 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \page qtwebengine-overview.html
+ \title Qt WebEngine Overview
+
+ The Qt WebEngine module provides a web browser engine that makes it easy to embed content from
+ the World Wide Web into your Qt application on platforms that do not have a native web engine.
+ The web engine is not intended to function as a \e {Web Runtime}; to display web content in a
+ QML application by using APIs native to the platform, use the \l{Qt WebView} module, instead.
+
+ Qt WebEngine provides C++ classes and QML types for rendering HTML, XHTML, and SVG documents,
+ styled using Cascading Style Sheets (CSS) and scripted with JavaScript. HTML documents can be
+ made fully editable by the user through the use of the \c{contenteditable} attribute on HTML
+ elements.
+
+ Qt WebEngine supercedes the \l{Qt WebKit Widgets}{Qt WebKit} module, which is based on the
+ WebKit project, but has not been actively synchronized with the upstream WebKit code since
+ Qt 5.2 and has been deprecated in Qt 5.5. For tips on how to change a Qt WebKit widgets
+ application to use Qt WebEngine widgets, see \l{Porting from Qt WebKit to Qt WebEngine}. For new
+ applications, we recommend using Qt Quick and the WebEngineView QML type.
+
+ \section1 Qt WebEngine Architecture
+
+ \image qtwebengine-architecture.png
+
+ The functionality in Qt WebEngine is divided into the following modules:
+
+ \list
+ \li \l{Qt WebEngine Widgets}, which provides a web browser engine and C++ classes to render
+ web content and to interact with it
+ \li \l{Qt WebEngine}, which provides QML types for rendering web content within a QML
+ application
+ \li \l{Qt WebEngine Core}, which provides common API used by Qt WebEngine and
+ Qt WebEngine Widgets
+ \endlist
+
+ The Qt WebEngine core is based on the \l{http://www.chromium.org}{Chromium Project}. Chromium
+ provides its own network and painting engines and is developed tightly together with its
+ dependent modules, and therefore Qt WebEngine provides better and more reliable support for the
+ latest HTML5 specification than Qt WebKit. However, Qt WebEngine is thus heavier than Qt WebKit
+ and does not provide direct access to the network stack and the HTML document through C++ APIs.
+
+ Chromium is tightly integrated to the \l{Qt Quick Scene Graph}{Qt Quick scene graph}, which is
+ based on OpenGL ES 2.0 or OpenGL 2.0 for its rendering. This provides you with one-pass
+ compositing of web content and all the Qt Quick UI. The integration to Chromium is transparent
+ to developers, who just work with Qt and JavaScript.
+
+ To expose QObjects to JavaScript, developers can use the \l {Qt WebChannel} module.
+
+ \section1 Embedding Web Content into Widget Based Applications
+
+ Use the QWebEngineView class to display web pages in the simplest way. Because it is a widget,
+ you can embed QWebEngineView into your forms and use its convenience functions to download and
+ display web sites.
+
+ \code
+ QWebEngineView *view = new QWebEngineView(parent);
+ view->load(QUrl("http://www.qt.io/"));
+ view->show();
+ \endcode
+
+ An instance of QWebEngineView has one QWebEnginePage. QWebEnginePage provides access to the
+ page's navigation history and the ability to run JavaScript code in the context of the page's
+ main frame and enables customization of handlers for specific events like showing custom
+ authentication dialogs.
+
+ \section1 Embedding Web Content into Qt Quick Applications
+
+ The WebEngineView QML type allows QML applications to render regions of dynamic web content. A
+ \e{WebEngineView} type may share the screen with other QML types or encompass the full screen
+ as specified within the QML application.
+
+ An application can load pages into the WebEngineView, using either an URL or HTML string, and
+ navigate within session history. By default, links to different pages load within the same
+ WebEngineView object, but web sites may request them to be opened as a new tab, window, or
+ dialog.
+
+ The following sample QML application loads a web page and responds to session history context:
+
+ \code
+ import QtQuick 2.1
+ import QtQuick.Controls 1.1
+ import QtWebEngine 1.0
+
+ ApplicationWindow {
+ width: 1280
+ height: 720
+ visible: true
+ WebEngineView {
+ id: webview
+ url: "http://www.qt.io"
+ anchors.fill: parent
+ }
+ }
+ \endcode
+
+ \section1 Using WebEngine Core
+
+ Qt WebEngine Core provides an API shared by Qt WebEngine and Qt WebEngine Widgets.
+
+ \section1 License Information
+
+ Qt WebEngine module is a snapshot of the integration of Chromium into Qt.
+
+ Qt Commercial Edition licensees that wish to distribute applications that
+ use the Qt WebEngine module need to be aware of their obligations under the
+ GNU Library General Public License (LGPLv2).
+
+ Developers using the Open Source Edition can choose to redistribute
+ the module under the GNU LGPLv3 or GPLv2 and up.
+
+ \legalese
+
+ Chromium is licensed under the following license:
+
+ Copyright (c) 2013 The Chromium Authors. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions are
+ met:
+
+ * Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the following disclaimer
+ in the documentation and/or other materials provided with the
+ distribution.
+ * Neither the name of Google Inc. nor the names of its
+ contributors may be used to endorse or promote products derived from
+ this software without specific prior written permission.
+
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ \endlegalese
+*/
diff --git a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
new file mode 100644
index 000000000..7104b7bd7
--- /dev/null
+++ b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
@@ -0,0 +1,39 @@
+/*
+ Copyright (C) 2015 The Qt Company Ltd.
+ Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+/*!
+ \qmlmodule QtWebEngine 1.0
+ \title Qt WebEngine QML Types
+ \brief Provides QML types for rendering web content within a QML application
+ \ingroup qtwebengine-qmlmodules
+
+ The QML types can be imported into your application using the following import statements in
+ your .qml file:
+
+ \code
+ import QtQuick 2.0
+ import QtWebEngine 1.0
+ \endcode
+*/
diff --git a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview.qdoc
similarity index 92%
rename from src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
rename to src/webengine/doc/src/webengineview.qdoc
index 5f41fde67..5b816454c 100644
--- a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
+++ b/src/webengine/doc/src/webengineview.qdoc
@@ -24,54 +24,6 @@
// by its LGPL license. Documentation written from scratch for new methods should be
// placed inline in the code as usual.
-/*!
- \page qtwebengine-index.html
- \title Qt WebEngine
-
- The Qt WebEngine module provides the WebEngineView API which allows QML applications
- to render regions of dynamic web content. A \e{WebEngineView} component may share
- the screen with other QML components or encompass the full screen as
- specified within the QML application.
-
- It allows an application to load pages into the WebEngineView, either by URL or with
- an HTML string, and navigate within session history. By default,
- links to different pages load within the same WebEngineView, but web sites may
- request them to be opened as a new tab, window or dialog.
-
- The following sample QML application loads a web page, responds to session
- history context.
-
- \code
- import QtQuick 2.1
- import QtQuick.Controls 1.1
- import QtWebEngine 1.0
-
- ApplicationWindow {
- width: 1280
- height: 720
- visible: true
- WebEngineView {
- id: webview
- url: "http://www.qt-project.org"
- anchors.fill: parent
- }
- }
- \endcode
-
- \section1 API References
-
- \list
- \li \l{Qt WebEngine QML Types}{QML Types}
- \endlist
-
- \section1 Examples
-
- There are several Qt WebEngine examples located in the
- \l{Qt WebEngine Examples} page.
-
-*/
-
-
/*!
\qmltype WebEngineView
\instantiates QQuickWebEngineView
diff --git a/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf b/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf
index ad1e46f1c..df01f449e 100644
--- a/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf
+++ b/src/webenginewidgets/doc/qtwebenginewidgets.qdocconf
@@ -32,8 +32,10 @@ tagfile = ../../../doc/qtwebenginewidgets/qtwebenginewidgets.tag
depends += qtwebengine qtcore qtnetwork qtgui qtwidgets qtwebkit qtdoc
headerdirs += ../api
-sourcedirs += ../api
-exampledirs += ../../../examples/webenginewidgets .
+sourcedirs += ../api src
+
+exampledirs += ../../../examples/webenginewidgets \
+ snippets
navigation.landingpage = "Qt WebEngine Widgets"
navigation.cppclassespage = "Qt WebEngine Widgets C++ Classes"
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
new file mode 100644
index 000000000..eff22be26
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-examples.qdoc
@@ -0,0 +1,38 @@
+/*
+ Copyright (C) 2015 The Qt Company Ltd.
+ Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
+
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+ notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+ notice, this list of conditions and the following disclaimer in the
+ documentation and/or other materials provided with the distribution.
+
+ THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
+ EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
+ DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+*/
+
+/*!
+ \group webengine-widgetexamples
+ \title Qt WebEngine Widgets Examples
+ \brief Examples demonstrating the Qt WebEngine Widgets usage
+ \ingroup all-examples
+
+ Qt provides an integrated Web browser component based on Chromium, the popular
+ open source browser engine.
+
+ These examples and demonstrations show a range of different uses for Qt WebEngine,
+ from displaying Web pages within a Qt user interface to an implementation of
+ a basic function Web browser.
+*/
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc
similarity index 58%
rename from src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
rename to src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc
index 1e8cda065..77596a370 100644
--- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-index.qdoc
@@ -25,75 +25,30 @@
**
****************************************************************************/
-/*!
- \module QtWebEngineWidgets
- \title Qt WebEngine Widgets C++ Classes
- \qtvariable webenginewidgets
- \brief Provides a web browser engine as well as C++ classes to render and
- interact with web content
-
- To include the definitions of the module's classes, use the
- following directive:
-
- \snippet snippets/qtwebengine_build_snippet.qdoc 1
-
- To link against the module, add this line to your \l qmake \c
- .pro file:
-
- \snippet snippets/qtwebengine_build_snippet.qdoc 0
-*/
-
/*!
\page qtwebenginewidgets-index.html
\title Qt WebEngine Widgets
\ingroup modules
- \brief The Qt WebEngine Widgets module provides a web browser engine as
- well as C++ classes to display and interact with web content.
-
- Qt WebEngine Widgets gives you a Web browser engine that you can use to
- embed content easily from the World Wide Web into your Qt application.
-
- Qt WebEngine Widgets lets you display HyperText Markup Language version 5
- (HTML5), Extensible HyperText Markup Language (XHTML) and Scalable Vector
- Graphics (SVG) documents, styled using Cascading Style Sheets (CSS) and
- scripted with JavaScript.
-
- HTML and XHTML documents can also be made fully editable to the user by
- using the \c{contenteditable} attribute on HTML elements.
+ \brief Provides a web browser engine as well as C++ classes to render web content and interact
+ with it.
- Qt WebEngine is based on the Chromium project. See the
- \l{http://www.chromium.org}{Chromium Project} Web site for more information.
-
- \section1 Including In Your Project
+ \section1 Getting Started
To include the definitions of the module's classes, use the
following directive:
- \snippet snippets/qtwebengine_build_snippet.qdoc 1
-
- To link against the module, add this line to your \l qmake \c
- .pro file:
-
- \snippet snippets/qtwebengine_build_snippet.qdoc 0
+ \snippet qtwebengine_build_snippet.qdoc 1
- \section1 Architecture
+ To link against the module, add this line to your qmake project file:
- Use the QWebEngineView class to display web pages in the simplest way.
- Because it's a widget, you can embed QWebEngineView into your forms and use
- its convenience functions to download and display web sites.
+ \snippet qtwebengine_build_snippet.qdoc 0
- \snippet snippets/simple/main.cpp Using QWebEngineView
-
- An instance of QWebEngineView has one QWebEnginePage. QWebEnginePage
- provides access to the page's navigation history, ability to run JavaScript
- code in the context of the page's main frame, and enables customization of
- handlers for specific events like showing custom authentication dialogs.
-
- \section1 Reference Documentation
+ \section1 Articles and Guides
\list
- \li \l {Qt WebEngine Widgets C++ Classes}
+ \li \l{Qt WebEngine Overview}
+ \li \l{Porting from Qt WebKit to Qt WebEngine}
\endlist
\section1 Examples
@@ -102,7 +57,14 @@
\li \l {Qt WebEngine Widgets Examples}
\endlist
+ \section1 API Reference
+
+ \list
+ \li \l {Qt WebEngine Widgets C++ Classes}
+ \endlist
+
\section1 License Information
+
This is a snapshot of the integration of Chromium into Qt.
Qt Commercial Edition licensees that wish to distribute applications that
@@ -146,17 +108,3 @@
\endlegalese
*/
-
-/*!
- \group webengine-widgetexamples
- \title Qt WebEngine Widgets Examples
- \brief Examples demonstrating the Qt WebEngine Widgets usage
- \ingroup all-examples
-
- Qt provides an integrated Web browser component based on Chromium, the popular
- open source browser engine.
-
- These examples and demonstrations show a range of different uses for Qt WebEngine,
- from displaying Web pages within a Qt user interface to an implementation of
- a basic function Web browser.
-*/
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
new file mode 100644
index 000000000..6373389f3
--- /dev/null
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets-module.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \module QtWebEngineWidgets
+ \title Qt WebEngine Widgets C++ Classes
+ \brief Provides a web browser engine as well as C++ classes to render and
+ interact with web content
+ \ingroup qtwebengine-modules
+
+ To include the definitions of the module's classes, use the
+ following directive:
+
+ \snippet qtwebengine_build_snippet.qdoc 1
+
+ To link against the module, add the following to your qmake project file:
+
+ \snippet qtwebengine_build_snippet.qdoc 0
+*/
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 676643387..e1990af73 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -351,7 +351,7 @@
was found; otherwise the callback value will be false.
For example:
- \snippet snippets/qtwebengine_qwebenginepage_snippet.cpp 0
+ \snippet qtwebengine_qwebenginepage_snippet.cpp 0
*/
/*!
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 163e9a28e..76878e077 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -41,7 +41,7 @@
Qt widgets, the show() function must be invoked in order to display
QWebEngineView. The snippet below illustrates this:
- \snippet snippets/simple/main.cpp Using QWebEngineView
+ \snippet simple/main.cpp Using QWebEngineView
Alternatively, setUrl() can also be used to load a web site. If you have
the HTML content readily available, you can use setHtml() instead.
@@ -170,7 +170,7 @@
It is equivalent to
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 0
+ \snippet qtwebengine_qwebengineview_snippet.cpp 0
*/
/*!
@@ -231,7 +231,7 @@
The following example triggers the copy action and therefore copies any
selected text to the clipboard.
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 2
+ \snippet qtwebengine_qwebengineview_snippet.cpp 2
\sa pageAction()
*/
@@ -268,7 +268,7 @@
It is equivalent to
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 3
+ \snippet qtwebengine_qwebengineview_snippet.cpp 3
\sa reload(), pageAction(), loadFinished()
*/
@@ -280,7 +280,7 @@
It is equivalent to
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 4
+ \snippet qtwebengine_qwebengineview_snippet.cpp 4
\sa forward(), pageAction()
*/
@@ -292,7 +292,7 @@
It is equivalent to
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 5
+ \snippet qtwebengine_qwebengineview_snippet.cpp 5
\sa back(), pageAction()
*/
@@ -386,7 +386,7 @@
It is equivalent to
- \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 6
+ \snippet qtwebengine_qwebengineview_snippet.cpp 6
\sa QWebEngineSettings::globalSettings()
*/
--
GitLab