Add example to Dialog

Change-Id: I9adc43344ba13eb95038f1d5bffcef73ab93fa9e
2014-09-12 12:57:23 +02:00 · 2014-09-12 12:57:23 +02:00 · 98faacc5ef
commit 98faacc5ef
parent a90f086536
1 changed files with 22 additions and 1 deletions
--- a/src/plasmaquick/dialog.h
+++ b/src/plasmaquick/dialog.h
@ -56,7 +56,28 @@ class DialogPrivate;
 * @class Dialog
 * @short QML wrapper for dialogs
 *
- * Exposed as `PlasmaCore.Dialog` in QML.
+ * Exposed as `Dialog` inside org.kde.plasma.core 2.0
+ *
+ * @code{.qml}
+ *  import QtQuick 2.0
+ *  import org.kde.plasma.core 2.0 as PlasmaCore
+ *  Item {
+ *     PlasmaCore.Dialog {
+ *          visible: true
+ *          mainItem: Item {
+ *              width: 500
+ *              height: 500
+ *
+ *              Text {
+ *                  anchors.centerIn: parent
+ *                  color: "red"
+ *                  text: "text"
+ *              }
+ *          }
+ *      }
+ * }
+ * @endcode
+ *
 */
 class PLASMAQUICK_EXPORT Dialog : public QQuickWindow, public QQmlParserStatus
 {