D23771: Improve API documentation for Definition::setKeywordList()

[Nikita Sirgienko]

sirgienko added inline comments.

INLINE COMMENTS

> definition.h:344
>       *
> -     * This function can be usefull for dynamic higlighting, when the document rehiglights more, that one time.
> -     * For example, you have a program for editing and running Octave scripts files and
> -     * you are using KSyntaxHighlighting for syntax higlighting. But also, you can request list of
> -     * variables, functions, etc from corresponed Octave process.
> -     * And, used this function, you can provide Octave live higlighting - by passing, for
> -     * example, variables names from Octave to KSyntaxHighlighting variable keyword list via this function.
> +     * @note In general, changing keyword lists via setKeywordList() in general
> +     *       is discouraged, since if a keyword list name  in the syntax

> In general, ... in general

Is it correct? Or just accidental typo?

REPOSITORY
  R216 Syntax Highlighting

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

To: dhaumann, sirgienko
Cc: kwrite-devel, kde-frameworks-devel, LeGast00n, GB_2, domson, michaelh, ngraham, bruns, demsking, cullmann, sars, dhaumann
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kwrite-devel/attachments/20190907/c4b69b22/attachment.html>