Review Request 122910: Introduce KMoreTools

[Gregor Mi]

> On March 15, 2015, 10:31 a.m., Dominik Haumann wrote:
> > src/kmoretools/kmoretools.h, line 36
> > <https://git.reviewboard.kde.org/r/122910/diff/1/?file=354447#file354447line36>
> >
> >     Proper doxygen would look like this: The first sentence is always the "brief" documentation.
> >     Currently, your brief documentation says "Introduction". This is certainly not what you want.
> >     
> >     More correct is:
> >     /**
> >      * Easy access to more tools.
> >      * 
> >      * @section kmt_intro Introduction
> >      * 
> >      * KMoreTools helps to you provide easy access to external applications ...
> >     
> >     It's also better to start with a true text, and not immediately with a list after a single word.
> >     
> >     If you want, you can have a look at e.g. ktexteditor/src/include/Document.h for how you can use doxygen to comment the code.
> >     
> >     Also AFAIK, it is still recomended to wrap the code and comments at latest 80 characters.

Interestingly, kapidox seems to understand the markdown synatx for headings. I tried it out (http://api.kde.org/frameworks-api/frameworks5-apidocs/kapidox/html/, sudo zypper install kapidox, kgenapidox ./frameworks/knewstuff/). It generates 3 headings (Introduction, Details and TODOs). Nevertheless, I also see now that there are plenty of issues to be fixed when I look at the generated documentation.


- Gregor


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


On March 11, 2015, 11:06 p.m., Gregor Mi wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/122910/
> -----------------------------------------------------------
> 
> (Updated March 11, 2015, 11:06 p.m.)
> 
> 
> Review request for KDE Frameworks, Emmanuel Pescosta and Jeremy Whiting.
> 
> 
> Repository: knewstuff
> 
> 
> Description
> -------
> 
> Moved from kservice (https://git.reviewboard.kde.org/r/122576/) to here (knewstuff).
> 
> Example usages:
> - dolphin's SpaceInfoToolsMenu: https://git.reviewboard.kde.org/r/122911/
> - kate's project addin: https://git.reviewboard.kde.org/r/122374/
> 
> 
> Diffs
> -----
> 
>   src/CMakeLists.txt 3b9a403eb473e0c3760506b2757c71d603b99775 
>   src/kmoretools/kmoretools.h PRE-CREATION 
>   src/kmoretools/kmoretools.cpp PRE-CREATION 
>   src/kmoretools/kmoretools_p.h PRE-CREATION 
>   src/kmoretools/kmoretoolsconfigdialog_p.h PRE-CREATION 
>   src/kmoretools/kmoretoolsconfigdialog_p.cpp PRE-CREATION 
>   src/kmoretools/ui/kmoretoolsconfigwidget.ui PRE-CREATION 
>   tests/CMakeLists.txt 103c5fc98deaf83288b843cc66a87f2d95ad9dfb 
>   tests/kmoretools/1/a.desktop PRE-CREATION 
>   tests/kmoretools/1/b.desktop PRE-CREATION 
>   tests/kmoretools/1/c.desktop PRE-CREATION 
>   tests/kmoretools/2/kate.desktop PRE-CREATION 
>   tests/kmoretools/2/kate.png PRE-CREATION 
>   tests/kmoretools/2/mynotinstalledapp.desktop PRE-CREATION 
>   tests/kmoretools/2/mynotinstalledapp.png PRE-CREATION 
>   tests/kmoretools/kmoretoolstest.cpp PRE-CREATION 
> 
> Diff: https://git.reviewboard.kde.org/r/122910/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Gregor Mi
> 
>

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