Add since tags.
ClosedPublic

Authored by tfry on Jun 6 2017, 7:20 PM.

Details

Reviewers
dfaure
Group Reviewers
Frameworks
Commits
R216:e48e34bd0288: Add since tags.
Summary

I hate having to look up when interesting new classes were added.
Patch is straight-forward (I think), but:

  • should @since be added on all memebers, when it's already on the class?
  • would simple patches such as this be ok to commit without review?

Diff Detail

Repository
R216 Syntax Highlighting
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
tfry created this revision.Jun 6 2017, 7:20 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptJun 6 2017, 7:20 PM
cfeck added a subscriber: cfeck.Jun 6 2017, 8:32 PM

The patch is simple, but it is always a good idea to ask for a review.

Since this frameworks is new as of 5.28, should we really mark each class this way? We did not do this for other "new" frameworks, such as prison or kwayland.

tfry added a comment.Jun 7 2017, 6:53 AM
In D6122#114655, @cfeck wrote:

Since this frameworks is new as of 5.28, should we really mark each class this way? We did not do this for other "new" frameworks, such as prison or kwayland.

You mean, if I'm not sure whether the framework exists, I should just test for it in cmake. Arguably true, but to an application developer, it is important to be able to pin down when I can reasonably expect something to be available on my target platforms. Without having to resort to code archeology.

Qt marks version of appearance for classes in "new" modules such as QWebEngine, too. Too bad, if we don't do this consistently (yet), but I cannot see how it could possibly be "better" not to.

dfaure accepted this revision.Jun 12 2017, 7:10 AM
dfaure added a subscriber: dfaure.

Excellent idea. I would say, we should have done the same in other new frameworks. If we treat KF5 as a whole, then these classes are simply "new since 5.28" in a bigger "package" that already existed (KF5).

This revision is now accepted and ready to land.Jun 12 2017, 7:10 AM
This revision was automatically updated to reflect the committed changes.