Review Request 115206: Correct spelling, grammar and style of kcompletion.h docs

[Alex Merry]

> On Jan. 21, 2014, 11:43 p.m., Alex Merry wrote:
> > src/kcompletion.h, line 501
> > <https://git.reviewboard.kde.org/r/115206/diff/1/?file=235092#file235092line501>
> >
> >     One sentence: "This signal is emitted by makeCompletion() when a match is found.
> 
> David Gil Oliva wrote:
>     Since more methods emit this signal, I have rephrased it further. makeCompletion() doesn't emit empty strings, but previousMatch() and nextMatch() do emit empty strings when there is no match. In the next days I will update the patch.
>     
>          /**
>          * This signal is emitted by makeCompletion() when a match is found.
>          * @param item the match. In previousMatch() and nextMatch() it can
>          * be a QString() if none is found.
>          */

How about
     /**
     * This signal is emitted when a match is found.
     *
     * In particular, makeCompletion(), previousMatch() and nextMatch() all
     * emit this signal; makeCompletion() will only emit it when a match is
     * found, but the other methods will always emit it (and so may emit it
     * with an empty string).
     *
     * @param item  the matching item, or QString() if there were no more
     *              matching items.
     */

And a similar thing for matches().


- Alex


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/115206/#review47958
-----------------------------------------------------------


On Jan. 21, 2014, 11:12 p.m., David Gil Oliva wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115206/
> -----------------------------------------------------------
> 
> (Updated Jan. 21, 2014, 11:12 p.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kcompletion
> 
> 
> Description
> -------
> 
> Correct spelling, grammar and style of kcompletion.h docs
> 
> 
> Diffs
> -----
> 
>   src/kcompletion.h 46b63a4 
> 
> Diff: https://git.reviewboard.kde.org/r/115206/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> David Gil Oliva
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140123/50405d7c/attachment.html>