summaryrefslogtreecommitdiffstats
path: root/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-08-19 12:30:48 +0200
committerLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2015-08-19 13:32:51 +0000
commit26d33081187c5b2865cfd2431202cacfde54c081 (patch)
treee8c752cc63a298684b7b9dc695007384b72c7fe7 /src/webengine/doc/src/qtwebengine-qmlmodule.qdoc
parent9317c7525ebd5f581ee19fb9123823820b54ce13 (diff)
Doc: reorganize and rename docs
- 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>
Diffstat (limited to 'src/webengine/doc/src/qtwebengine-qmlmodule.qdoc')
-rw-r--r--src/webengine/doc/src/qtwebengine-qmlmodule.qdoc39
1 files changed, 39 insertions, 0 deletions
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
+*/