API documentation style tweaks

Robert Knight robertknight at gmail.com
Mon May 21 23:04:06 CEST 2007


Hello,

I have a few proposed tweaks to make the API documentation easier to use.

- The most important is making the links to member methods in the
class details pages bold.  They are very hard to pick out otherwise.

- Sort the names of the member methods.  Again, without this it is
much more difficult to find a member whose name you have a fairly good
idea of.

- Provide brief one-line descriptions underneath the member method
names at the top of the list.

Patch against kdelibs/doc/common attached.

OK to commit?

Regards,
Robert.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: kdelibs_api_docs_readability.patch
Type: text/x-diff
Size: 1029 bytes
Desc: not available
Url : http://mail.kde.org/pipermail/kde-quality/attachments/20070521/17b39e5c/attachment.bin 


More information about the kde-quality mailing list