At MÄK we take developer documentation seriously. We recognize we haven’t always gotten it right, therefore we are continually trying to make it better. With new product releases starting this quarter, we will be overhauling how we present development documentation. The changes may be relatively subtle but we believe you will appreciate them.
Historically, we have always had two places developers needed to look to understand our APIs: The Developer's Guide, which was in PDF format, and the Class Documentation, an HTML guide to class usage. These two competing formats sometimes got out of sync because they weren’t reviewed at the same time, or because the class docs were generated automatically from the code thereby instantly reflecting changes. To solve these problems, we started moving code segments from the Developers Guide to the Class Docs, but this just made the split between the two documents more troublesome.