From: Peter Penz <peter.penz19@gmail.com>
Date: Tue, 17 Apr 2012 16:17:49 +0000 (+0200)
Subject: Documentation update for KItemListRoleEditor
X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/commitdiff_plain/9f94aac23f8b6519de4847063fa20f588f9797ea

Documentation update for KItemListRoleEditor
---

diff --git a/src/kitemviews/private/kitemlistroleeditor.h b/src/kitemviews/private/kitemlistroleeditor.h
index 14aa694ce..8a1439565 100644
--- a/src/kitemviews/private/kitemlistroleeditor.h
+++ b/src/kitemviews/private/kitemlistroleeditor.h
@@ -25,7 +25,14 @@
 #include <KTextEdit>
 
 /**
- * @brief
+ * @brief Editor for renaming roles of a KItemListWidget.
+ *
+ * Provides signals when the editing got cancelled (e.g. by
+ * pressing Escape or when losing the focus) or when the editing
+ * got finished (e.g. by pressing Enter or Return).
+ *
+ * The width automatically gets increased if the text does not
+ * fit into the available width.
  */
 class LIBDOLPHINPRIVATE_EXPORT KItemListRoleEditor : public KTextEdit
 {