On 4/19/06, Rob Church robchur@gmail.com wrote:
On 19/04/06, Tels nospam-abuse@bloodgate.com wrote:
It doesn't say what it is for, or what values it could have, or whatever. Almost every member or class definition I looked at looks like this, circulare references between files but nowhere any real doc beyond "it exist and is called foo".
Since at least for members there are usually comments (like for mTitle), should't the autogenerated doc pick them up and display them somehow?
As Avar said in a previous message; the documentation is limited in terms of the original code; if the comments to document it were not there, then the generated documentation will be sparse.
In my experience, this is a good time to mention that one of the best ways to learn a codebase is to go in and document it, so if there are any wanna-be MediaWiki masters out there... :)
(It is also possible that doxygen isn't picking up the member comments, though. Running doxygen locally and consulting the log it generates should give some clues, as will making sure that the comments are formatted in a way that will get picked up, although phpDoc and dOxygen are pretty friendly towards documetation styles.)
-- Ben Garney Torque Technologies Director GarageGames.Com, Inc.