Patch: kresources API documentation

Kevin Krammer kevin.krammer at gmx.at
Wed Sep 14 13:12:54 BST 2005


On Wednesday 14 September 2005 14:01, Adriaan de Groot wrote:

> Ah, excellent! One style issue: For making lists in Doxygen, don't use the
> HTML but use indented dash lists, like the following:
>
> /**
> * Defrobnicate the grommet under the following conditions:
> *
> *   - moon is full,
> *   - list is empty,
> *   - we're on Hoth and there is an \@\@ nearby
> *
> */

I have seen some older classes (KApplication for instance) using @li

Do you recommend using that markup or just the dash and have doxygen transform 
it into a list?

Cheers,
Kevin

-- 
Kevin Krammer <kevin.krammer at gmx.at>
Qt/KDE Developer, Debian User
Moderator: www.mrunix.de (German), www.qtforum.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20050914/31d0f6e2/attachment.sig>


More information about the kde-core-devel mailing list