In API document explain how to document each function ?What are the tools used for documentation?
- Description: Small description about what a function does
- Syntax: Syntax about the parameter of the code, the sequence in which they occur, required and optional elements etc.
- Parameters: Functions parameters
- Error Messages: Syntax of error messages
- Example Code: Small snippet of code
- Related Links: Related functions
Popular tools used for API documentations are JavaDoc (for Java code ) Doxygen (for .Net code)