Documentation update for KItemListRoleEditor

diff --git a/src/kitemviews/private/kitemlistroleeditor.h b/src/kitemviews/private/kitemlistroleeditor.h
index 14aa694cee37c48d05f40fdd1d601051ee4ad289..8a14395659ee3efea4c98121eb122ae233a5890e 100644 (file)
--- a/src/kitemviews/private/kitemlistroleeditor.h
+++ b/src/kitemviews/private/kitemlistroleeditor.h
@@ -25,7 +25,14 @@
 #include <KTextEdit>
 
 /**
 #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
 {
  */
 class LIBDOLPHINPRIVATE_EXPORT KItemListRoleEditor : public KTextEdit
 {