KDE libs documentation policy

[Benjamin Meyer]

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

I have noticed a lot of activity on improving the documentation of the classes 
in kdelibs and was curious if there was an official policy for the docs of 
the classes in kdelibs and if not, would there be interest in making an 
official policy.

A few ideas:
- -All public and protected functions much have documentation.
- -If class is a widget have a screenshot.
- -If applicable a demo usage in the class description.
- -An example application which shows usage of the class.

Of course very few classes even fulfill the above, but we could have it apply 
for all new classes that are added and attempt to improve the existing ones 
over time for KDE4

- -Benjamin Meyer

P.S. This of course can be added to the KDELibs policy which isn't on the 
policy page and even Google can not find. 
http://developer.kde.org/policies/index.html

- -- 
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/f5P71rZ3LTw38vIRAooHAJ9Wudqywcz+TwhmL3Fz7x0VTkJzvgCgmdpx
40h9qO8lWIZKXJcAhMEW12w=
=r6fh
-----END PGP SIGNATURE-----