I've been tasked with creating an API from one of our companies class libraries, which is something I haven't done before. For the documentation I was thinking of following an MSDN style approach and having a section for each class with it's method, properties etc, along with a code snippets displaying their use.
Is there anything else I should include? What do you hate being missing/vague?
I've not really worked with well documented API's yet.
Technically this project is an API for a 3rd companies API we utilise, it has barely any documentation and had to be reverse engineered by inspecting packets and a great deal of trail and error originally. Probably why they don't want to develop with it themselves but weird eh.
This post has been edited by negligible: 31 May 2012 - 08:49 AM