[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-core-devel
Subject:    Globals, Namespaces, and Documentation
From:       Neil Stevens <neil () qualityassistant ! com>
Date:       2003-08-19 22:37:17
[Download RAW message or body]

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

Now that Doxygen really is replacing kdoc in the library docs, it becomes 
important to fill in those missing features that the current Doxygen docs 
don't support.

First, the namespace list is missing.  Can that be uncommented please?  
kdoc put namespaces like KNotifyClient and KIO in with the classes, so 
they were always accessible.  Doxygen doesn't, so docs like KNotifyClient 
can't be read unless you know to type the filename/url manually.

Second, the list of globals is missing.  I'm scouring the Doxygen docs, but 
can't find any hints about how to get one.  So unless KDE 3.2 will be 
adding all the globals like i18n, locate, UserIcon, etc. into a KDE 
namespace, docs for those important functions disappears.

When I think about it, that namespace seems like a good idea for more 
reasons than just documentation.  Would anyone object to wrapping them all 
in namespace KDE, adding compatibility usings (to be removed for KDE 4)?

- -- 
Neil Stevens - neil@qualityassistant.com

"I'll believe it when I see it." -- George Walker Bush
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (FreeBSD)

iD8DBQE/Qqajf7mnligQOmERAk4/AJ9U2/+T2AwLfE4lR14TgYw6jyvLaACgiIju
YQspaXj/fppsm8aSpjAtjro=
=NKrG
-----END PGP SIGNATURE-----


[prev in list] [next in list] [prev in thread] [next in thread]