Review Request 115370: Fix apidox, fix code style and delete useless includes in KComboBox (KCompletion)

[David Gil Oliva]

> On Jan. 31, 2014, 8:07 p.m., Alex Merry wrote:
> > src/kcombobox.h, line 52
> > <https://git.reviewboard.kde.org/r/115370/diff/1/?file=240925#file240925line52>
> >
> >     funtionalities -> features

I also change this sentence

*   @li a completion object that provides both automatic
 * and manual text completion as well as text rotation features

to

*   @li a completion object that provides both automatic
 * and manual text completion as well as text rotation

Otherwise there are too many "features" in so a short text. Do you agree?


> On Jan. 31, 2014, 8:07 p.m., Alex Merry wrote:
> > src/kcombobox.h, line 183
> > <https://git.reviewboard.kde.org/r/115370/diff/1/?file=240925#file240925line183>
> >
> >     Why?  This is out of keeping with every other method's documentation...

The reason is that it is not a sentence because there's no verb. That's why it is more like a title, that therefore wouldn't need any full stop. But I imagine that doxygen wants a full stop, doesn't it?


> On Jan. 31, 2014, 8:07 p.m., Alex Merry wrote:
> > src/kcombobox.h, line 225
> > <https://git.reviewboard.kde.org/r/115370/diff/1/?file=240925#file240925line225>
> >
> >     While not strictly necessary, a line break after the first sentence makes it clearer to read (same goes for dox of other methods).
> >     
> >     I would also generally prefer a dox style where the description was like
> >     "Appends a URL with an icon to the combobox."
> >     and there were @param entries.  But I'm not going to reject the patch for not doing this.

Fixed the first one. I'll take into account the second one in the future.


- David


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


On Jan. 28, 2014, 10:44 p.m., David Gil Oliva wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/115370/
> -----------------------------------------------------------
> 
> (Updated Jan. 28, 2014, 10:44 p.m.)
> 
> 
> Review request for KDE Frameworks.
> 
> 
> Repository: kcompletion
> 
> 
> Description
> -------
> 
> Fix apidox, fix code style and delete useless includes.
> 
> 
> Diffs
> -----
> 
>   src/kcombobox.h f34d259 
>   src/kcombobox.cpp 2cfe6e7 
> 
> Diff: https://git.reviewboard.kde.org/r/115370/diff/
> 
> 
> Testing
> -------
> 
> It builds. Tests pass.
> 
> 
> Thanks,
> 
> David Gil Oliva
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20140204/916860da/attachment.html>