[patch] more human-readable titles for API docs

Allen Winter winter at kde.org
Wed Jun 13 15:39:26 BST 2007


On Wednesday 13 June 2007 6:59:41 am Jaroslaw Staniek wrote:
> David Jarvie said the following, On 2007-06-13 12:05:
> > On Tuesday 12 June 2007 23:44, Aaron J. Seigo wrote:
> >> On Tuesday 12 June 2007, Jarosław Staniek wrote:
> >>> RFC, this makes appearance of http://api.kde.org/4.0-api a bit more
> > professional, at least for non-core devs.
> >> looks nice =)
> >>
> >> missing a space between "Interface" and "to" on this line:
> >>
> >> + * @mainpage KSpeech - a D-Bus Interfaceto Text-to-Speech Service
> >>
> >> but otherwise looks nice =)
> > 
> > It's definitely an improvement :)  Another quibble is that the
> > capitalisation of minor words ('for', 'the', etc.) is inconsistent between
> > the different titles.
> 
> Yes, I noticed that, this needs another iteration, as well as may we need more
> // DOXYGEN_SET_PROJECT_NAME = ...
> lines (anyone has a problem with changing kdecore to KDECore in the left-hand 
> menu?)
> 
Jaroslaw,

Just about anything you want to do that improves the readability
and consistency of the apidox is great.  Let me know if there's
anything I can do to help, either from the EBN or the generation scripts.

-Allen




More information about the kde-core-devel mailing list