D17624: KTextEditor::Message: Review documentation

[loh tar]

loh.tar created this revision.
loh.tar added a reviewer: KTextEditor.
Herald added projects: Kate, Frameworks.
Herald added subscribers: kde-frameworks-devel, kwrite-devel.
loh.tar requested review of this revision.

REVISION SUMMARY
  - Reduce redundant text
  - Change some argument names in the hope it's an improvement
  - Update a code example to fit new style
  - Try to improve some wording
  - Add some @see, @p and such, but probably not all will be needed due to "auto reference"
  - Fix some outdated info

REPOSITORY
  R39 KTextEditor

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

AFFECTED FILES
  src/include/ktexteditor/message.h

To: loh.tar, #ktexteditor
Cc: kwrite-devel, kde-frameworks-devel, #ktexteditor, hase, michaelh, ngraham, bruns, demsking, cullmann, sars, dhaumann
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kwrite-devel/attachments/20181216/6b405942/attachment.html>