Patch: kresources API documentation

[Adriaan de Groot]

On Wednesday 14 September 2005 12:02, Alejandro Exojo wrote:
> The attached patch corrects some mistakes in the API documentation or
> KResources. Some classes have been renamed, and when used the example for
> copying and pasting to a real case, it needed some changes.

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.



-- 
These are your friends - Adem
    GPG: FEA2 A3FE Adriaan de Groot