Document QWindow::alert() in Qt Quick.

Task-number: QTBUG-32069
Task-number: QTBUG-30416

Change-Id: If7e9fd63d858416a23ff768272d94219595be1c5
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>

diff --git a/src/quick/items/qquickwindow.cpp b/src/quick/items/qquickwindow.cpp
index 619c72a..377228e 100644 (file)
--- a/src/quick/items/qquickwindow.cpp
+++ b/src/quick/items/qquickwindow.cpp
@@ -3196,6 +3196,18 @@ void QQuickWindow::setDefaultAlphaBuffer(bool useAlpha)
     Requests the window to be activated, i.e. receive keyboard focus.
  */
 
+/*!
+    \qmlmethod QtQuick2::Window::alert(int msec)
+    \since QtQuick 2.1
+
+    Causes an alert to be shown for \a msec miliseconds. If \a msec is \c 0 (the
+    default), then the alert is shown indefinitely until the window becomes
+    active again.
+
+    In alert state, the window indicates that it demands attention, for example by
+    flashing or bouncing the taskbar entry.
+*/
+
 #include "moc_qquickwindow.cpp"
 
 QT_END_NAMESPACE