[Differential] [Request, 6 lines] D4006: kcoreaddons: Fix clang documentation warnings

mpyne (Michael Pyne) noreply at phabricator.kde.org
Sat Jan 7 22:42:52 UTC 2017


mpyne created this revision.
mpyne added a reviewer: Frameworks.
mpyne set the repository for this revision to R244 KCoreAddons.
Restricted Application added a project: Frameworks.

REVISION 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.

REPOSITORY
  R244 KCoreAddons

REVISION DETAIL
  https://phabricator.kde.org/D4006

AFFECTED FILES
  src/lib/plugin/kpluginloader.h
  src/lib/text/ktexttohtml.h
  src/lib/util/kformat.h

EMAIL PREFERENCES
  https://phabricator.kde.org/settings/panel/emailpreferences/

To: mpyne, #frameworks
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20170107/f17b2c6f/attachment.html>


More information about the Kde-frameworks-devel mailing list