Review Request: kdebase runner syntax

[Dario Freddi]

Hello,

This patch is really some great stuff, since it is the really needed first 
step to build docs for KRunners. Though, I have one main concern about the 
example syntaxes and description.

A syntax can have unlimited examples but one single description. This is the 
only weird point to me. I don't really get when I should add another example 
to the syntax or a completely different syntax, since I can document only a 
syntax, and not each example on its own.

Maybe I didn't get what you meant, and in this case I'd suggest you to update 
the API docs, since I find it a bit confusing; or otherwise, just let every 
syntax have a single example, that in the end (from my point of view) could be 
clearer to developers and easier to use when creating (in the future) a 
KRunner documentation.

Just my 2 cents, more than that I just hope that this could get in as soon as 
possible. If nobody already volunteered to add documentation to the Add Runner 
dialog, I do.

On Saturday 21 March 2009 18:10:49 Aaron Seigo wrote:
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.kde.org/r/373/
> -----------------------------------------------------------
>
> (Updated 2009-03-21 10:10:49.543387)
>
>
> Review request for Plasma.
>
>
> Changes
> -------
>
> added apidox. a review of the API, thoughts on it being a nested class, etc
> would be appreciated. :)
>
>
> Summary
> -------
>
> Patch provides syntax registration for runners in kdebase.
>
>
> Diffs (updated)
> -----
>
>   trunk/KDE/kdelibs/plasma/abstractrunner.h 942401
>   trunk/KDE/kdelibs/plasma/abstractrunner.cpp 942401
>   trunk/KDE/kdelibs/plasma/runnermanager.cpp 942401
>
> Diff: http://reviewboard.kde.org/r/373/diff
>
>
> Testing
> -------
>
>
> Thanks,
>
> Aaron
>
> _______________________________________________
> Plasma-devel mailing list
> Plasma-devel at kde.org
> https://mail.kde.org/mailman/listinfo/plasma-devel

-- 
-------------------

Dario Freddi
KDE Developer
GPG Key Signature: 511A9A3B


-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 197 bytes
Desc: This is a digitally signed message part.
Url : http://mail.kde.org/pipermail/plasma-devel/attachments/20090321/be418c65/attachment.sig