1
0
mirror of https://invent.kde.org/system/dolphin synced 2024-07-02 16:31:23 +00:00

Add documentation

This commit is contained in:
Felix Ernst 2024-02-18 11:40:25 +01:00 committed by Felix Ernst
parent 33247d6699
commit 803a1b36db
3 changed files with 24 additions and 2 deletions

View File

@ -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

View File

@ -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

View File

@ -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
{