> This is something we're working on. One of the big objectives for the > PalmSource developer services group is to improve the cross-referencing of > sample code on our website. We're trying to get to a system like MSDN > where the documentation for API calls points to code that shows how they > are used. This hasn't been the Palm OS documentation philosophy in the > past, but we're trying to change and make things better. It's great to hear that PalmSource is working on improving the docs.
A radical idea (actually, not so radical, but it might look like that to some): allow people to comment on docs. You need to break the docs into logical chunks (easy for API docs, each API call is a chunk) and write some code but as PHP example shows (see e.g. http://www.php.net/manual/en/language.operators.php) it can be made to work very well i.e. user contributed additions to the docs are really valuable and after you set up the system, you get them pretty much for free (I understand they do some editorial work from time to time i.e. remove bogus comments, integrate some of the comments into the docs themselves etc.) I don't know if the source of their doc framework is available but it wouldn't be that hard to write. Krzysztof Kowalczyk | http://blog.kowalczyk.info -- For information on using the Palm Developer Forums, or to unsubscribe, please see http://www.palmos.com/dev/support/forums/
