Patch: kresources API documentation

Alejandro Exojo suy at kurly.org
Wed Sep 14 17:22:22 BST 2005


El Miércoles, 14 de Septiembre de 2005 14:01, Adriaan de Groot escribió:
> 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
> *
> */
>
> That's nicer to read in the header files themselves. Notice how later in
> the dox there is already a dash-list.

OK. I just left the used style untouched in the previous patch, because I 
wanted to change the minimum possible. What about now? The one attached in 
this mail, converts the list to dashes, and wraps long lines, so the ugly 
horizontal scroll doesn't appears.

-- 
Alex (a.k.a. suy) - GPG ID 0x0B8B0BC2
http://darkshines.net/ - Jabber ID: suy at bulmalug.net
-------------- next part --------------
A non-text attachment was scrubbed...
Name: kresources-apidox.patch
Type: text/x-diff
Size: 5730 bytes
Desc: not available
URL: <http://mail.kde.org/pipermail/kde-core-devel/attachments/20050914/a7760070/attachment.patch>


More information about the kde-core-devel mailing list