Document Kirigami::Icon
ClosedPublic

Authored by cblack on Apr 8 2020, 9:19 PM.

Details

Reviewers
mart
Group Reviewers
Kirigami
Commits
R169:9dba4c8b1583: Document Kirigami::Icon
Summary

There are now documentation comments for Kirigami::Icon.

Diff Detail

Repository
R169 Kirigami
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
cblack created this revision.Apr 8 2020, 9:19 PM
Restricted Application added a project: Kirigami. · View Herald TranscriptApr 8 2020, 9:19 PM
Restricted Application added a subscriber: plasma-devel. · View Herald Transcript
cblack requested review of this revision.Apr 8 2020, 9:19 PM

+1
documentation improvements are always very welcome

src/icon.h
37

Maybe instead of internet something like "a remote url" since it may be from the local network as well

69

Maybe mention that it's read-only. Do we have some standard way of doing that?

cblack added inline comments.Apr 9 2020, 1:36 AM
src/icon.h
69

It's mentioned by Doxygen

broulik added a subscriber: broulik.Apr 9 2020, 7:09 AM

Generally +1 on better docs

src/icon.h
53

Mention Default is "unknown"

58

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

71–75

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

81

"Typically used when an element is hovered"?

85

Huh?

99

Selected

113

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

cblack planned changes to this revision.Apr 9 2020, 2:34 PM

Those @includes aren't resolving properly, will fix

cblack updated this revision to Diff 79744.Apr 10 2020, 1:20 AM

Fix Doxygen issues

cblack updated this revision to Diff 79787.Apr 10 2020, 7:04 PM
cblack marked 10 inline comments as done.

Address feedback

mart accepted this revision.Apr 20 2020, 3:55 PM
This revision is now accepted and ready to land.Apr 20 2020, 3:55 PM
This revision was automatically updated to reflect the committed changes.