ginebra2/ChromeEffect.h
changeset 6 1c3b8676e58c
parent 5 0f2326c2a325
--- a/ginebra2/ChromeEffect.h	Wed Jun 23 17:59:43 2010 +0300
+++ b/ginebra2/ChromeEffect.h	Tue Jul 06 14:03:49 2010 +0300
@@ -28,12 +28,16 @@
 
 namespace GVA {
 
-/*
+/*!
  * The ChromeEffect namespace is intended to provide settings and drawing methods that can be
  * used by various classes for common display requirements, so far, just disabled mode drawing is
  * supported but more can be added...
  */
 namespace ChromeEffect {
+    /*!
+     * Paint a rectangle that will give the underlying item a "disabled" look -- ie. whitewashed
+     * or darkened or whatever the UI spec is.
+     */
     void paintDisabledRect(QPainter *painter, const QRectF &rect);
 
     static qreal disabledOpacity = 0.65;