Doc: edit QWebEnginePage docs

- Add missing documentation
- Edit for grammar and style
- Fix links

Change-Id: I9e8387fa08f8e7e73c636a516b1f87eb10973e73
Reviewed-by: Florian Bruhin <qt-project.org@the-compiler.org>
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>

1 files changed, 53 insertions, 16 deletions

diff --git a/src/webenginewidgets/api/qwebenginepage.cpp b/src/webenginewidgets/api/qwebenginepage.cpp
index 80baf1c74..677f67cbe 100644
--- a/src/webenginewidgets/api/qwebenginepage.cpp
+++ b/src/webenginewidgets/api/qwebenginepage.cpp
@@ -382,10 +382,44 @@ QWebEnginePage::QWebEnginePage(QObject* parent)
 }
 
 /*!
-    Constructs an empty QWebEnginePage in the QWebEngineProfile \a profile with parent \a parent.
+    \enum QWebEnginePage::RenderProcessTerminationStatus
+
+    This enum describes the status with which the render process terminated:
+
+    \value  NormalTerminationStatus
+            The render process terminated normally.
+    \value  AbnormalTerminationStatus
+            The render process terminated with with a non-zero exit status.
+    \value  CrashedTerminationStatus
+            The render process crashed, for example because of a segmentation fault.
+    \value  KilledTerminationStatus
+            The render process was killed, for example by \c SIGKILL or task manager kill.
+*/
+
+/*!
+    \fn QWebEnginePage::renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode)
+
+    This signal is emitted when the render process is terminated with a non-zero exit status.
+    \a terminationStatus is the termination status of the process and \a exitCode is the status code
+    with which the process terminated.
+*/
+
+/*!
+    \fn QWebEnginePage::fullScreenRequested(bool fullScreen)
 
-    If the profile is not the default profile the caller must ensure the profile is alive for as
-    long as the page is.
+    This signal is emitted when the web page issues the request to enter or exit fullscreen mode.
+    If \a fullScreen is \c true, the page wants to enter the mode and if it is \c false, the page
+    wants to exit the mode.
+
+    \sa isFullScreen(), QWebEngineSettings::FullScreenSupportEnabled
+*/
+
+/*!
+    Constructs an empty web engine page in the web engine profile \a profile with the parent
+    \a parent.
+
+    If the profile is not the default profile, the caller must ensure that the profile stays alive
+    for as long as the page does.
 
     \since 5.5
 */
@@ -417,12 +451,12 @@ QWebEngineSettings *QWebEnginePage::settings() const
 }
 
 /*!
- * Returns a pointer to the web channel instance used by this page, or a null pointer if none was set.
- * This channel is automatically using the internal QtWebEngine transport mechanism over Chromium IPC,
- * and exposed in the javascript context of this page as  \c qt.webChannelTransport
+ * Returns a pointer to the web channel instance used by this page or a null pointer if none was set.
+ * This channel automatically uses the internal web engine transport mechanism over Chromium IPC
+ * that is exposed in the JavaScript context of this page as \c qt.webChannelTransport.
  *
  * \since 5.5
- * \sa {QtWebChannel::QWebChannel}{QWebChannel}
+ * \sa QWebChannel
  */
 QWebChannel *QWebEnginePage::webChannel() const
 {
@@ -431,14 +465,14 @@ QWebChannel *QWebEnginePage::webChannel() const
 }
 
 /*!
- * Sets the web channel instance to be used by this page and connects it to QtWebEngine's transport
- * using Chromium IPC messages. That transport is exposed in the javascript context of this page as
+ * Sets the web channel instance to be used by this page to \a channel and connects it to
+ * web engine's transport using Chromium IPC messages. The transport is exposed in the JavaScript
+ * context of this page as
  * \c qt.webChannelTransport, which should be used when using the \l{Qt WebChannel JavaScript API}.
  *
- * \note The page does not take ownership of the \a channel object.
+ * \note The page does not take ownership of the channel object.
  *
  * \since 5.5
- * \param channel
  */
 
 void QWebEnginePage::setWebChannel(QWebChannel *channel)
@@ -449,12 +483,12 @@ void QWebEnginePage::setWebChannel(QWebChannel *channel)
 
 /*!
     \property QWebEnginePage::backgroundColor
-    \brief the page's background color, behing the document's body.
+    \brief the page's background color behind the document's body.
     \since 5.6
 
-    You can set it to Qt::transparent or to a translucent
-    color to see through the document, or you can set this color to match your
-    web content in an hybrid app to prevent the white flashes that may appear
+    You can set the background color to Qt::transparent or to a translucent
+    color to see through the document, or you can set it to match your
+    web content in a hybrid application to prevent the white flashes that may appear
     during loading.
 
     The default value is white.
@@ -486,7 +520,7 @@ QWidget *QWebEnginePage::view() const
 }
 
 /*!
-    Returns the QWebEngineProfile the page belongs to.
+    Returns the web engine profile the page belongs to.
     \since 5.5
 */
 QWebEngineProfile *QWebEnginePage::profile() const
@@ -1247,6 +1281,9 @@ bool QWebEnginePage::acceptNavigationRequest(const QUrl &url, NavigationType typ
     return true;
 }
 
+/*!
+    Returns \c true if the web view is in fullscreen mode, \c false otherwise.
+*/
 bool QWebEnginePage::isFullScreen()
 {
     Q_D(const QWebEnginePage);