KDE libs documentation policy
Tim Jansen
tim at tjansen.de
Sun Oct 5 18:31:14 BST 2003
On Sunday 05 October 2003 18:15, Benjamin Meyer wrote:
> > A few more basic things are also needed:
> > - the capitalization of @param and @return fields (I prefer lower case at
> You mean @param vs @Param? and '.' at the end of the sentance?
No,
@param the value to convert
versus
@param The value to convert
versus
@param The value to convert.
> It should be noted that Qt doesn't use @param, @return at all, but simply
> has sentances that make reference to all of the args and return value.
This is bad IMHO, since you need to look through the text when you want to
read the definition of a single argument. It also is no help for IDEs, so you
can not show the definition of the argument that you are currently typing.
bye...
More information about the kde-core-devel
mailing list