KDE libs documentation policy

[Tim Jansen]

On Sunday 05 October 2003 20:45, Benjamin Meyer wrote:
> > @param the value to convert
> Don't forget adding "-" into the line to get things like: "@param foo - the
> value to convert"  

Do not use the "-", it is added by the doc processor. In the best case the 
generator is smart enough to delete yours (because it is a common mistake), 
the others will render it and you have a double "-" or similar effects.

> Does anyone know what the default java doc way of doing it is?

"@param foo the value to convert"  would be Java style, but the '.' at the end 
seems to depend on the text:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide

bye...