API Documentation Feedback

[cPanelMatt]

We are currently working on getting API2 documented and we feel that community feedback on the method that we have been using would be extremely valuable.

Currently we have three sets of API Docs:

XML and JSON APIs
API Reference
cPanel API2 Documentation

Now, as you will notice there are two formats to this:

1.) the XML-API format

Every page contains verbose output about how to call the API, Examples included in output

2.) the "new" API documentation format (this is the one at API Reference )

The function listing is essential like traditional API references where it is just a listing about functions within a module with input & output parameters included. Information about how to call these are included elxewhere



I personally feel that option #2 is the most valuable because that once someone learns how to call them this is a very efficient format to use. However I would like feedback from all interested parties about how you feel these should be laid out.

[bvierra]

I also like #2... easy to use and all the information is there.