D19320: Assign documentation to correct enum value (corrects commit 8579ec54)

Thomas Fischer noreply at phabricator.kde.org
Mon Feb 25 20:52:41 GMT 2019


thomasfischer created this revision.
thomasfischer added a project: Documentation.
Herald added a project: Frameworks.
Herald added a subscriber: kde-frameworks-devel.
thomasfischer requested review of this revision.

REVISION SUMMARY
  In commit 8579ec54 <https://phabricator.kde.org/R237:8579ec54838b7188ed016f7adb4a69bbf2e39712> (D13034 <https://phabricator.kde.org/D13034>), the `Notify` value got introduced in `enum WriteConfigFlag` in KConfigBase. When adding this new value, the value and its documentation (Doxygen format, `/**<`) got placed wrongly.
  After commit 8579ec54 <https://phabricator.kde.org/R237:8579ec54838b7188ed016f7adb4a69bbf2e39712>, the documentation for `Notify` "documents" the previously existing value `Localized`, whereas the documentation for `Localized` documents `Notify`.
  Simply exchanging the order of the documentation comments should fix this issue.

TEST PLAN
  See the automatically generated online documentation for enum WriteConfigFlag <https://api.kde.org/frameworks/kconfig/html/classKConfigBase.html#a748289f31b54c48d2ef03d66546718aa>

REPOSITORY
  R237 KConfig

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

AFFECTED FILES
  src/core/kconfigbase.h

To: thomasfischer
Cc: kde-frameworks-devel, gennad, michaelh, ngraham, bruns, skadinna
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20190225/af189b11/attachment.html>


More information about the Kde-frameworks-devel mailing list