From 7059162155a82ddd109ce812a74b234598f50cd7 Mon Sep 17 00:00:00 2001
From: Topi Reinio <topi.reinio@digia.com>
Date: Thu, 2 Oct 2014 09:54:21 +0200
Subject: [PATCH] Doc: Use proper module name for Qt WebEngine Widgets
Fix the name used for the \module command to include the
module name to properly generate the C++ class reference
page for Qt WebEngine Widgets, and link to the new page
from the module landing page.
Change-Id: If0814650fa16ecf1b5c66e8e46e598d576a8c21d
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@digia.com>
---
src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc | 8 +++++++-
src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc | 4 ++--
src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc | 2 +-
src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc | 2 +-
src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc | 2 +-
5 files changed, 12 insertions(+), 6 deletions(-)
diff --git a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
index c2a3ac329..3f6e888f3 100644
--- a/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
+++ b/src/webenginewidgets/doc/src/qtwebenginewidgets.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
- \module QtWebEngine
+ \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
@@ -111,6 +111,12 @@
customization of handlers for specific events such as showing custom authentication
dialogs.
+ \section1 Reference Documentation
+
+ \list
+ \li \l {Qt WebEngine Widgets C++ Classes}
+ \endlist
+
\section1 License Information
This is a snapshot of the integration of Chromium into Qt.
diff --git a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
index 76a0a075d..1e791c03a 100644
--- a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc
@@ -26,7 +26,7 @@
\class QWebEngineHistoryItem
\brief The QWebEngineHistoryItem class represents one item in the history of a QWebEnginePage
- \inmodule QtWebEngine
+ \inmodule QtWebEngineWidgets
Each QWebEngineHistoryItem instance represents an entry in the history stack of a Web page,
containing information about the page, its location, and when it was last visited.
@@ -101,7 +101,7 @@
\class QWebEngineHistory
\brief The QWebEngineHistory class represents the history of a QWebEnginePage
- \inmodule QtWebEngine
+ \inmodule QtWebEngineWidgets
Each QWebEnginePage instance contains a history of visited pages that can be accessed
by QWebEnginePage::history(). QWebEngineHistory represents this history and makes it possible
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 11281c9ac..983b80d7e 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -28,7 +28,7 @@
\class QWebEnginePage
\brief The QWebEnginePage class provides an object to view and edit web documents.
- \inmodule QtWebEngine
+ \inmodule QtWebEngineWidgets
QWebEnginePage holds a main frame responsible for web content, the history
of navigated links and actions.
diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
index 2d82bef3b..3c420b805 100644
--- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc
@@ -36,7 +36,7 @@
\brief The QWebEngineSettings class provides an object to store the settings used
by QWebEnginePage
- \inmodule QtWebEngine
+ \inmodule QtWebEngineWidgets
Each QWebEnginePage object has its own QWebEngineSettings object, which configures the
settings for that page. If a setting is not configured, then it is looked
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index 2d49158d6..57d537656 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -30,7 +30,7 @@
web documents.
\ingroup advanced
- \inmodule QtWebEngine
+ \inmodule QtWebEngineWidgets
QWebEngineView is the main widget component of the Qt WebEngine web browsing module.
It can be used in various applications to display web content live from the
--
GitLab