A good documentation is must for any foundation. API documentation serves as quick reference for accessing library or working within a program.
When we use any such documents, it must consists of proper plan, content source, proper layout, information related to each function etc.
There are various documentation tools like Doxygen and JavaDoc. Here, are the functions which are documented which revolve around the parameters like:
- Function description
- Type and syntax of error message that may occure
- Syntax, elements and sequence needed for each parameter
- Links regarding functions