[KWidgetsAddons] Fix APIDOX issues raised by clang's -Wdocumentation
ClosedPublic

Authored by cfeck on Feb 18 2017, 1:59 AM.

Details

Summary

As found by Kevin Funk.

Diff Detail

Repository
R236 KWidgetsAddons
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
cfeck created this revision.Feb 18 2017, 1:59 AM
Restricted Application added a project: Frameworks. · View Herald TranscriptFeb 18 2017, 1:59 AM
aacid accepted this revision.Feb 18 2017, 11:31 AM
aacid added a subscriber: aacid.

Looks good, fix the comments and commit!

src/kpagewidget.h
143

Does the other @param in this line also need to be @p ? Or even removed?

src/kpagewidgetmodel.h
297

Same as above

This revision is now accepted and ready to land.Feb 18 2017, 11:31 AM
cfeck added inline comments.Feb 22 2017, 3:45 PM
src/kpagewidget.h
143

You are correct. I just checked the rendering on api.kde.org, and both should just use @p, otherwise it would start a new line for the parameter description.

This revision was automatically updated to reflect the committed changes.