D28688: Document Kirigami::Icon
This revision was automatically updated to reflect the committed changes. Closed by commit R169:9dba4c8b1583: Document Kirigami::Icon (authored by cblack). CHANGED PRIOR TO COMMIT https://phabricator.kde.org/D28688?vs=79787=80709#toc REPOSITORY R169 Kirigami CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D28688?vs=79787=80709 REVISION DETAIL https://phabricator.kde.org/D28688 AFFECTED FILES Mainpage.dox docs/pics/icon/active.png docs/pics/icon/selected.png examples/icon/CustomSource.qml examples/icon/Fallback.qml examples/icon/FilesystemSource.qml examples/icon/IconThemeSource.qml examples/icon/InternetSource.qml examples/icon/ResourceSource.qml src/icon.h To: cblack, #kirigami, mart Cc: broulik, nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
D28688: Document Kirigami::Icon
cblack updated this revision to Diff 79787. cblack marked 10 inline comments as done. cblack added a comment. Address feedback REPOSITORY R169 Kirigami CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D28688?vs=79744=79787 BRANCH cblack/document-icon (branched from master) REVISION DETAIL https://phabricator.kde.org/D28688 AFFECTED FILES Mainpage.dox docs/pics/icon/active.png docs/pics/icon/selected.png examples/icon/CustomSource.qml examples/icon/Fallback.qml examples/icon/FilesystemSource.qml examples/icon/IconThemeSource.qml examples/icon/InternetSource.qml examples/icon/ResourceSource.qml src/icon.h To: cblack, #kirigami Cc: broulik, nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
D28688: Document Kirigami::Icon
cblack updated this revision to Diff 79744. cblack added a comment. Fix Doxygen issues REPOSITORY R169 Kirigami CHANGES SINCE LAST UPDATE https://phabricator.kde.org/D28688?vs=79669=79744 BRANCH cblack/document-icon (branched from master) REVISION DETAIL https://phabricator.kde.org/D28688 AFFECTED FILES Mainpage.dox docs/pics/icon/active.png docs/pics/icon/selected.png examples/icon/CustomSource.qml examples/icon/Fallback.qml examples/icon/FilesystemSource.qml examples/icon/IconThemeSource.qml examples/icon/InternetSource.qml examples/icon/ResourceSource.qml src/icon.h To: cblack, #kirigami Cc: broulik, nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
D28688: Document Kirigami::Icon
cblack planned changes to this revision. cblack added a comment. Those `@include`s aren't resolving properly, will fix 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
D28688: Document Kirigami::Icon
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
D28688: Document Kirigami::Icon
cblack added inline comments. INLINE COMMENTS > nicolasfella wrote in icon.h:69 > Maybe mention that it's read-only. Do we have some standard way of doing that? It's mentioned by Doxygen REPOSITORY R169 Kirigami REVISION DETAIL https://phabricator.kde.org/D28688 To: cblack, #kirigami Cc: nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
D28688: Document Kirigami::Icon
nicolasfella added a comment. +1 documentation improvements are always very welcome INLINE COMMENTS > icon.h:37 > + * @include icon/FilesystemSource.qml > + * * The Internet: > + * @include icon/InternetSource.qml Maybe instead of internet something like "a remote url" since it may be from the local network as well > icon.h:69 > +/** > + * The `implicitWidth` of this item, derived from the `source` image. > + */ Maybe mention that it's read-only. Do we have some standard way of doing that? REPOSITORY R169 Kirigami REVISION DETAIL https://phabricator.kde.org/D28688 To: cblack, #kirigami Cc: nicolasfella, plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
D28688: Document Kirigami::Icon
cblack created this revision. cblack added a reviewer: Kirigami. Herald added a project: Kirigami. Herald added a subscriber: plasma-devel. cblack requested review of this revision. REVISION SUMMARY There are now documentation comments for Kirigami::Icon. REPOSITORY R169 Kirigami BRANCH cblack/document-icon (branched from master) REVISION DETAIL https://phabricator.kde.org/D28688 AFFECTED FILES Mainpage.dox src/doc/icon/CustomSource.qml src/doc/icon/Fallback.qml src/doc/icon/FilesystemSource.qml src/doc/icon/IconThemeSource.qml src/doc/icon/InternetSource.qml src/doc/icon/ResourceSource.qml src/icon.h src/img/icon/active.png src/img/icon/selected.png To: cblack, #kirigami Cc: plasma-devel, fbampaloukas, GB_2, domson, dkardarakos, ngraham, apol, ahiemstra, davidedmundson, mart
