Review Request: Make the api docs more readable

Michael Pyne mpyne at kde.org
Wed Nov 11 01:06:43 GMT 2009


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


Now I prefer "fluid layout" instead of fixed-width layouts on the Web myself.  But I would caution against
declaring that using 100% of available width is more readable.  After all, centuries of typography seem to indicate that people have an easier time reading somewhat narrower text (e.g. the columnar layout of magazines, newspapers, journals, etc.)

At the same time, computer typography is /not/ the same as print typography.  I guess the point I'm trying to make is that is may still make sense to have some kind of max width if CSS supports (i.e. I see a commented-out max-width property), perhaps set to 12-15 cm or so.  Or make the text size a bit bigger to compensate for the wider lines.

I understand this is very bikesheddable (and that the user can simply resize the window...).  I'll try the CSS changes on my widescreen monitor to see if it looks crazy or not.

- Michael


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