D28688: Document Kirigami::Icon

[Kai Uwe Broulik]

broulik added a comment.


  Generally +1 on better docs

INLINE COMMENTS

> icon.h:53
> +    /**
> +     * The name of a fallback icon to load from the icon theme when the `source`
> +     * cannot be found.

Mention `Default is "unknown"`

> icon.h:58
> +     * 
> +     * @note This will only be loaded if source is not found.
> +     */

is not found, or is it "failed to load"?

> icon.h:71
> +     */
>      Q_PROPERTY(int implicitWidth READ implicitWidth CONSTANT)
> +

Urgh, I wonder why this property got shadowed and why it is `CONSTANT` :0

> icon.h:81
> +     * resulting in a graphical effect being applied to the icon to indicate that
> +     * it is currently active.
> +     * 

"Typically used when an element is hovered"?

> icon.h:85
> +     * 
> +     * The color differences under the default KDE color palette, Breeze. Note
> +     * that a dull blue background is typically displayed behind active elements.

Huh?

> icon.h:96
> +    /**
> +     * Whether this icon will use the QIcon::Active mode when drawing the icon,
> +     * resulting in a graphical effect being applied to the icon to indicate that

`Selected`

> icon.h:108
> +    /**
> +     * Whether this icon will be filled with a solid color.
> +     * 

This sounds to me as if you end up with a colored square. :)

REPOSITORY
  R169 Kirigami

REVISION DETAIL
  https://phabricator.kde.org/D28688

To: cblack, #kirigami
Cc: broulik, nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/plasma-devel/attachments/20200409/6a27fe1f/attachment.html>