PalmSource was once known for their next-to-perfect API documentation. Failures, bugs, hints and other useful stuff were contained right in the Palm OS API documentation. However, as PalmSource staff got less, the quality of the documentation decreased according to developer’s oppinion(I still consider it useful btw – so this is no rant).
Anyways, while coding a little PHP script, I needed help about a call and looked at the official PHP documentation:
I quickly found out that the function I needed wasn’t available in the PHP version that our current host(HostLoco) runs. However, the comments contained like 15 ready-to-use replacement functions and hints on usage!
The PHP API documentation system has two parts – the first part is ‘fixed’; and the second part consists of comments like we have it at TamsPalm’s. So, vandals cant change the core documentation, but users can add hints easily.
IMHO, PalmSource should convert its Developer’s API Reference to this format if they somehow can…developers would greatly benefit from the extra amount of knowledge available!
What do you think?