From f9b2ad74fc7978f7a68da1f10ce5051d2fa463e4 Mon Sep 17 00:00:00 2001
From: "Aaron J. Seigo" <aseigo@kde.org>
Date: Tue, 20 Oct 2009 16:37:25 +0000
Subject: [PATCH] api docs and note an API wart that should be fixed in the
 next BIC release

svn path=/trunk/KDE/kdelibs/; revision=1038110
---
 dialog.cpp |  1 +
 dialog.h   | 11 +++++++++++
 2 files changed, 12 insertions(+)

diff --git a/dialog.cpp b/dialog.cpp
index 770118244..c5f51b582 100644
--- a/dialog.cpp
+++ b/dialog.cpp
@@ -466,6 +466,7 @@ void Dialog::setGraphicsWidget(QGraphicsWidget *widget)
     }
 }
 
+//BIC FIXME: should be const
 QGraphicsWidget *Dialog::graphicsWidget()
 {
     return d->graphicsWidget;
diff --git a/dialog.h b/dialog.h
index cfabcc05b..4c68ee688 100644
--- a/dialog.h
+++ b/dialog.h
@@ -73,7 +73,18 @@ class PLASMA_EXPORT Dialog : public QWidget
         explicit Dialog(QWidget * parent = 0, Qt::WindowFlags f =  Qt::Window);
         virtual ~Dialog();
 
+        /**
+         * Sets a QGraphicsWidget to be shown as the content in this dialog.
+         * The dialog will then set up a QGraphicsView and coordinate geometry with
+         * the widget automatically.
+         *
+         * @arg widget the QGraphicsWidget to display in this dialog
+         */
         void setGraphicsWidget(QGraphicsWidget *widget);
+
+        /**
+         * @return the graphics widget shown in this dialog
+         */
         QGraphicsWidget *graphicsWidget();
 
         /**