2011-02-10 Ademar de Souza Reis Jr <ademar.reis@openbossa.org>
authorcommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 10 Feb 2011 21:59:52 +0000 (21:59 +0000)
committercommit-queue@webkit.org <commit-queue@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 10 Feb 2011 21:59:52 +0000 (21:59 +0000)
        Reviewed by Andreas Kling.

        [Qt] Misc documentation fixes/updates
        https://bugs.webkit.org/show_bug.cgi?id=54236

        There are a few commits in the Qt repository (master and 4.7 branches)
        with QtWebKit documentation fixes:

        84d278501a19eaccf9a77cccd95ca5d17a2dcd2b
        Clarified documentation of loadFinished() signal

        eebe205b306daaa3674d9746de11a73bef4bd0de
        Doc: Fixed QML, unindented snippet

        b0d64717d2c541976dc5524e4100c62f060e206f
        doc: Changed a table into 3 tables to eliminate a \raw.

        As these are all minor doc changes, I decided to group them
        into one single patch.

        * Api/qwebpage.cpp:
        * declarative/qdeclarativewebview.cpp:
        * docs/qtwebkit.qdoc:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@78266 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit/qt/Api/qwebpage.cpp
Source/WebKit/qt/ChangeLog
Source/WebKit/qt/declarative/qdeclarativewebview.cpp
Source/WebKit/qt/docs/qtwebkit.qdoc

index 99eaf916775c674dcc289f76a050d38f671b6a41..075756d41f1d6217bf43199923680e873d84b0ee 100644 (file)
@@ -1886,9 +1886,10 @@ QWebPage::ViewportAttributes& QWebPage::ViewportAttributes::operator=(const QWeb
     The loadStarted() signal is emitted when the page begins to load.The
     loadProgress() signal, on the other hand, is emitted whenever an element
     of the web page completes loading, such as an embedded image, a script,
-    etc. Finally, the loadFinished() signal is emitted when the page has
-    loaded completely. Its argument, either true or false, indicates whether
-    or not the load operation succeeded.
+    etc. Finally, the loadFinished() signal is emitted when the page contents
+    are loaded completely, independent of script execution or page rendering.
+    Its argument, either true or false, indicates whether or not the load
+    operation succeeded.
 
     \section1 Using QWebPage in a Widget-less Environment
 
@@ -3988,7 +3989,7 @@ quint64 QWebPage::bytesReceived() const
 /*!
     \fn void QWebPage::loadStarted()
 
-    This signal is emitted when a new load of the page is started.
+    This signal is emitted when a page starts loading content.
 
     \sa loadFinished()
 */
@@ -4007,7 +4008,8 @@ quint64 QWebPage::bytesReceived() const
 /*!
     \fn void QWebPage::loadFinished(bool ok)
 
-    This signal is emitted when a load of the page is finished.
+    This signal is emitted when the page finishes loading content. This signal
+    is independant of script execution or page rendering.
     \a ok will indicate whether the load was successful or any error occurred.
 
     \sa loadStarted(), ErrorPageExtension
index b3451299619e133a6e6e1c4d9d80a101254abf5b..f0dc116938697135f83d5ceaae0dc0560b66823f 100644 (file)
@@ -1,3 +1,29 @@
+2011-02-10  Ademar de Souza Reis Jr  <ademar.reis@openbossa.org>
+
+        Reviewed by Andreas Kling.
+
+        [Qt] Misc documentation fixes/updates
+        https://bugs.webkit.org/show_bug.cgi?id=54236
+
+        There are a few commits in the Qt repository (master and 4.7 branches)
+        with QtWebKit documentation fixes:
+
+        84d278501a19eaccf9a77cccd95ca5d17a2dcd2b
+        Clarified documentation of loadFinished() signal
+
+        eebe205b306daaa3674d9746de11a73bef4bd0de
+        Doc: Fixed QML, unindented snippet
+
+        b0d64717d2c541976dc5524e4100c62f060e206f
+        doc: Changed a table into 3 tables to eliminate a \raw.
+
+        As these are all minor doc changes, I decided to group them
+        into one single patch.
+
+        * Api/qwebpage.cpp:
+        * declarative/qdeclarativewebview.cpp:
+        * docs/qtwebkit.qdoc:
+
 2011-02-10  Ademar de Souza Reis Jr  <ademar.reis@openbossa.org>
 
         Reviewed by Andreas Kling.
index e26889ee8658c7a8f9a8b1ccf78c852ded918820..73fe66161ba1d7eb3f19dfe0ecd40ff94adc45ee 100644 (file)
@@ -730,11 +730,11 @@ QWebPage* QDeclarativeWebView::page() const
     See QWebSettings for details of these properties.
 
     \qml
-        WebView {
-            settings.pluginsEnabled: true
-            settings.standardFontFamily: "Arial"
-            ...
-        }
+    WebView {
+        settings.pluginsEnabled: true
+        settings.standardFontFamily: "Arial"
+        // ...
+    }
     \endqml
 */
 QDeclarativeWebSettings* QDeclarativeWebView::settingsObject() const
index df22e650f0a4834b23e1932462438ec4d3f87b0b..1e769015798bd7d2a10551e77c78fa8f5bad6788 100644 (file)
     The following locations are searched for plugins:
 
     \table
-    \header \o Linux/Unix (X11)  \o Windows
-    \row \o{1,3}
+    \header \o Linux/Unix (X11)
+    \row \o
     \list
     \o \c{.mozilla/plugins} in the user's home directory
     \o \c{.netscape/plugins} in the user's home directory
     \o \c{$QTWEBKIT_PLUGIN_PATH}
     \endlist
     \endlist
+    \endtable
 
-    \o
+    \table
+    \header  \o Windows
+    \row \o
     \list
     \o The user's \c{Application Data\Mozilla\plugins} directory
     \o Standard system locations of plugins for Quicktime, Flash, etc.
     \endlist
+    \endtable
 
-    \row
-    \raw HTML
-    <th class="qt-style">Mac OS X</th>
-    \endraw
-    \row
-    \o
+    \table
+    \header \o Mac OS X
+    \row \o
     \list
     \o \c{Library/Internet Plug-Ins} in the user's home directory
     \o The system \c{/Library/Internet Plug-Ins} directory