1 files changed, 12 insertions, 0 deletions

diff --git a/libopie/colordialog.h b/libopie/colordialog.h
index 474bc61..926f8f2 100644
--- a/libopie/colordialog.h
+++ b/libopie/colordialog.h
@@ -23,48 +23,60 @@
 ** Agreement provided with the Software.
 **
 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 **
 ** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
 **   information about Qt Commercial License Agreements.
 ** See http://www.trolltech.com/qpl/ for QPL licensing information.
 ** See http://www.trolltech.com/gpl/ for GPL licensing information.
 **
 ** Contact info@trolltech.com if any conditions of this licensing are
 ** not clear to you.
 **
 **********************************************************************/
 
 #ifndef OColorDialog_H
 #define OColorDialog_H
 
 #ifndef QT_H
 #include <qdialog.h>
 #endif // QT_H
 
 class OColorDialogPrivate;
 
+/**
+ * @class OColorDialog
+ * @brief The OColorDialog class is a copy of QColorDialog for use in Opie.
+ *
+ * OColorDialog is a copy of TrollTech's QColorDialog for use in Opie.  The default
+ * build of QT/Embedded used by Opie does not include QColorDialog, so it is provided
+ * here.  It is renamed to prevent conflicts in the event the QColorDialog is included
+ * at a later date in QP/E.
+ *
+ * See http://doc.trolltech.com/2.3/qcolordialog.html for complete documentation of
+ * QColorDialog.
+ */
 class Q_EXPORT OColorDialog : public QDialog
 {
     Q_OBJECT
 
 public:
     static QColor getColor( QColor, QWidget *parent=0, const char* name=0 ); // ### 3.0: make const QColor&
     static QRgb getRgba( QRgb, bool* ok = 0,
                          QWidget *parent=0, const char* name=0 );
 
 private:
     ~OColorDialog();
 
     OColorDialog( QWidget* parent=0, const char* name=0, bool modal=FALSE );
     void setColor( QColor ); // ### 3.0: make const QColor&
     QColor color() const;
 
 private:
     void setSelectedAlpha( int );
     int selectedAlpha() const;
 private:
     OColorDialogPrivate *d;
     friend class OColorDialogPrivate;
 
         private:// Disabled copy constructor and operator=