Review Request: Make the api docs more readable

Aaron Seigo aseigo at kde.org
Wed Nov 11 01:06:59 GMT 2009


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard.kde.org/r/2132/#review3009
-----------------------------------------------------------


non-alphabetical makes it even more difficult to find methods in many cases; personally, i'd like to see our apidox as close to Qt's as possible for consistency's sake.

when i look at http://api.kde.org/4.x-api/kdelibs-apidocs/plasma/html/classPlasma_1_1Corona.html for instance, i have the ctor at the top of the public member functions (good!) but slots and signals are above that which doesn't make a whole lot of sense.


- Aaron


On 2009-11-11 00:25:34, Sebastian Trueg wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.kde.org/r/2132/
> -----------------------------------------------------------
> 
> (Updated 2009-11-11 00:25:34)
> 
> 
> Review request for kdelibs.
> 
> 
> Summary
> -------
> 
> There have always been a few things that annoyed me about the KDE api docs. This patch fixes two of them:
> 1. Members are now sorted according to declaration order. This makes way more sense than alphabetical order since most if not all developers try to put the members in a proper order anyway and having to find constructors somewhere in between all other members is just annoying.
> 2. Use the full width of the browser window. API docs need to be readable and line-breaks are never a goo thing here. Thus, using all the space we have is a must.
> 
> 
> Diffs
> -----
> 
>   trunk/KDE/kdelibs/doc/common/Doxyfile.global 1047248 
>   trunk/KDE/kdelibs/doc/common/kde.css 1047248 
> 
> Diff: http://reviewboard.kde.org/r/2132/diff
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> Sebastian
> 
>





More information about the kde-core-devel mailing list