KDE libs documentation policy

[Benjamin Meyer]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Sunday 05 October 2003 1:31 pm, Tim Jansen wrote:
> 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...

Don't forget adding "-" into the line to get things like: "@param foo - the 
value to convert"  Does anyone know what the default java doc way of doing it 
is?

- -Benjamin Meyer

- -- 
Public Key: http://www.csh.rit.edu/~benjamin/public_key.asc
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.6 (GNU/Linux)
Comment: For info see http://www.gnupg.org

iD8DBQE/gGbT1rZ3LTw38vIRAl5bAJ9Kfcgn2XSa32LfosQr8AE9HJT7LwCgmQBi
Y1wgleS8vdIwWxjgf9yz5OE=
=QjCe
-----END PGP SIGNATURE-----