Add documentation

[dolphin.git] / src / kitemviews / kfileitemlistwidget.h

diff --git a/src/kitemviews/kfileitemlistwidget.h b/src/kitemviews/kfileitemlistwidget.h
index 7f33c548700637a9fd798e71b2f3a56ddd6d920d..6e98e03c4a49243d1e45cdd9b88d42a0afa85b3d 100644 (file)
--- a/src/kitemviews/kfileitemlistwidget.h
+++ b/src/kitemviews/kfileitemlistwidget.h
@@ -12,6 +12,13 @@
 
 class KFileItemListView;
 
+/**
+ * @brief ItemList widget informant implementation for use with KFileItems.
+ *
+ * Code that does not expect KFileItems specifically should go to KStandardItemListWidgetInformant.
+ *
+ * @see KItemListWidgetInformant
+ */
 class DOLPHIN_EXPORT KFileItemListWidgetInformant : public KStandardItemListWidgetInformant
 {
 public:
@@ -25,6 +32,13 @@ protected:
     QFont customizedFontForLinks(const QFont &baseFont) const override;
 };
 
+/**
+ * @brief ItemList widget implementation for use with KFileItems.
+ *
+ * Code that does not expect KFileItems specifically should go to KStandardItemListWidget.
+ *
+ * @see KItemListWidget
+ */
 class DOLPHIN_EXPORT KFileItemListWidget : public KStandardItemListWidget
 {
     Q_OBJECT