Expand KNewStuff documentation
ClosedPublic

Authored by leinir on May 17 2017, 12:56 PM.

Details

Summary

Add mention of KNewStuffCore and KNewStuffQuick to the base documentation, and expand the API documentation to mention some of the new functionality, as well as add some documentation for things which currently lack it. Prior to this, the documentation had no mention of the way the framework is now logically split up.

This deficiency was brought to my attention during a chat with a GSoC student, who was otherwise in the process of disregarding KNewStuff and headed towards reimplementing large parts of KNewStuffCore (as the documentation makes no suggestion this is now a thing that can be used on its own).

Diff Detail

Repository
R304 KNewStuff
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
leinir created this revision.May 17 2017, 12:56 PM
Restricted Application added a project: Frameworks. · View Herald TranscriptMay 17 2017, 12:56 PM
Restricted Application added a subscriber: Frameworks. · View Herald Transcript
apol added a subscriber: apol.May 17 2017, 4:16 PM
apol added inline comments.
README.md
30

I'd say that it looks better to have CONFIG rather than NO_MODULE. Both should work.

Also find_package(KF5 COMPONENTS NewStuffCore) reads better to my eye.

35

Do you ever need to link against NewStuffQuick?

leinir marked 2 inline comments as done.May 18 2017, 8:50 AM
leinir added inline comments.
README.md
30

It certainly does - i just expanded what was already there, but yup, needs a touch of work there. Also, since KNewStuffQuick is a Qt Quick module, it should really be marked as runtime when looking for it, so i'll fix that while i'm at it :)

35

No, you are quite right - i don't think it is even technically possible in most cases, so this will need some reworking to explain that (it's a Qt Quick module, after all)

leinir updated this revision to Diff 14660.May 18 2017, 9:17 AM
leinir marked 2 inline comments as done.
leinir updated this revision to Diff 15908.Jun 27 2017, 10:59 AM

Add/fix a whole bunch of more documentation, identified as missing (or incorrect) by Aniketh

apol added a comment.Jun 27 2017, 12:37 PM

General +1

README.md
35

Still it shouldn't be looked-for, should it?

leinir added inline comments.Jun 27 2017, 1:43 PM
README.md
35

It still need to be found before you can set it as runtime (unless i am fundamentally misunderstanding something of course) - like how it's done in Discover... or am i misunderstanding the question?

apol accepted this revision.Jun 27 2017, 2:09 PM
apol added inline comments.
README.md
35

Oh well fair enough.

This revision is now accepted and ready to land.Jun 27 2017, 2:09 PM
This revision was automatically updated to reflect the committed changes.