KDoc Styleguide

[David Faure]

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

On Saturday 07 September 2002 20:51, Tim Jansen wrote:
> Should you escape constants?
>    * @return @p true if the URL has a reference part
>    * @return true if the URL has a reference part

The former is wrong [at least with kdoc] !
@p is a way to refer to a _parameter_ name, in the middle of a sentence
(e.g. 
@param distance a distance
@param isAbs true if @p distance is absolute, false if it's relative
)

Using it for anything else is wrong.

- -- 
David FAURE, david at mandrakesoft.com, faure at kde.org
http://people.mandrakesoft.com/~david/
Contributing to: http://www.konqueror.org/, http://www.koffice.org/
KOffice-1.2-rc1 is out. ftp://ftp.kde.org/pub/kde/unstable/koffice-1.2-rc1/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.7 (GNU/Linux)

iD8DBQE9ewxq72KcVAmwbhARAhx+AJ4tLz0ELMV9q1QEaqeqxWH6xZaqjACeOlGy
Wtcq1N3ARHEeh2cstVNWim8=
=hc7e
-----END PGP SIGNATURE-----