From: Felix Ernst <felixernst@zohomail.eu>
Date: Sun, 18 Feb 2024 10:40:25 +0000 (+0100)
Subject: Add documentation
X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/commitdiff_plain/803a1b36dbb47342be6ca1dfa0b1e65baff74dbb

Add documentation
---

diff --git a/src/kitemviews/kfileitemlistwidget.h b/src/kitemviews/kfileitemlistwidget.h
index 7f33c5487..6e98e03c4 100644
--- 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
diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h
index 9f99b9d95..55d924719 100644
--- a/src/kitemviews/kitemlistwidget.h
+++ b/src/kitemviews/kitemlistwidget.h
@@ -22,7 +22,8 @@ class KItemListView;
 class QPropertyAnimation;
 
 /**
- * @brief Provides information for creating an instance of KItemListWidget.
+ * @brief Provides generic information for all KItemListWidgets
+ * for which the construction of any specific KItemListWidget isn't required.
  *
  * KItemListView only creates KItemListWidget instances for the visible
  * area. For calculating the required size of all items the expected
diff --git a/src/kitemviews/kstandarditemlistwidget.h b/src/kitemviews/kstandarditemlistwidget.h
index ca3cf52e1..06bf0529a 100644
--- a/src/kitemviews/kstandarditemlistwidget.h
+++ b/src/kitemviews/kstandarditemlistwidget.h
@@ -18,6 +18,11 @@ class KItemListRoleEditor;
 class KItemListStyleOption;
 class KItemListView;
 
+/**
+ * @brief standard implementation of the ItemList widget informant for use with KStandardItemListView and KStandardItemModel.
+ *
+ * @see KItemListWidgetInformant
+ */
 class DOLPHIN_EXPORT KStandardItemListWidgetInformant : public KItemListWidgetInformant
 {
 public:
@@ -67,7 +72,9 @@ protected:
 };
 
 /**
- * @brief ItemList widget implementation for KStandardItemListView and KStandardItemModel.
+ * @brief standard implementation of an ItemList widget for KStandardItemListView and KStandardItemModel.
+ *
+ * @see KItemListWidget
  */
 class DOLPHIN_EXPORT KStandardItemListWidget : public KItemListWidget
 {