kcoreaddons: Fix clang documentation warnings
ClosedPublic

Authored by mpyne on Jan 7 2017, 10:42 PM.

Details

Summary

This change corrects some minor API documentation errors in KCoreAddons noted by Kevin Funk when using clang with the -Wdocumentation flag to note potential Doxygen errors.

See https://paste.kde.org/p6r1o1m5j#line-47. For posterity, the applicable warnings were:

kcoreaddons/src/lib/plugin/kpluginloader.h:442:15: warning: parameter 'errorString' is already documented [-Wdocumentation]
kcoreaddons/src/lib/text/ktexttohtml.h:72:12: warning: parameter 'flags' not found in the function declaration [-Wdocumentation]
kcoreaddons/src/lib/util/kformat.h:185:15: warning: parameter 'specificUnit' not found in the function declaration [-Wdocumentation]

Test Plan

I have verified that the change builds.

Diff Detail

Repository
R244 KCoreAddons
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
mpyne updated this revision to Diff 9829.Jan 7 2017, 10:42 PM
mpyne retitled this revision from to kcoreaddons: Fix clang documentation warnings.
mpyne updated this object.
mpyne edited the test plan for this revision. (Show Details)
mpyne added a reviewer: Frameworks.
mpyne set the repository for this revision to R244 KCoreAddons.
Restricted Application added a project: Frameworks. · View Herald TranscriptJan 7 2017, 10:42 PM
apol accepted this revision.Jan 8 2017, 12:39 AM
apol added a reviewer: apol.
This revision is now accepted and ready to land.Jan 8 2017, 12:39 AM
This revision was automatically updated to reflect the committed changes.