KSqueezedTextLabel: Small improvements to API docs
ClosedPublic

Authored by rkflx on Aug 6 2017, 12:27 PM.

Details

Summary

Expand description, add missing documentation.

"Above" in source code does not imply "above" in generated API docs,
better use a reference.

Test Plan

Output of kapidox looks better.

Diff Detail

Repository
R236 KWidgetsAddons
Branch
arcpatch-D7161
Lint
No Linters Available
Unit
No Unit Test Coverage
rkflx created this revision.Aug 6 2017, 12:27 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptAug 6 2017, 12:27 PM
dhaumann accepted this revision.Aug 6 2017, 9:17 PM
dhaumann added a subscriber: dhaumann.

Looks certainly better than before, thanks a lot.

Mabye the "@note" about some methods being not virtual in the base class is even worth to put into the main class documentation. Can you commit yourself?

This revision is now accepted and ready to land.Aug 6 2017, 9:17 PM
rkflx updated this revision to Diff 17969.Aug 10 2017, 4:45 PM

Mabye the "@note" about some methods being not virtual in the base class is even worth to put into the main class documentation.

Good idea, let's move it to the class description (to be referenced from each affected function).

rkflx added a comment.Aug 13 2017, 6:24 AM

Can you commit yourself?

Now I can :) (Thanks for your support with that!)

Will commit once all four patches have been accepted.

This revision was automatically updated to reflect the committed changes.