Jump to content

API documentation

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by SimonP (talk | contribs) at 22:10, 26 May 2005 (Category:Documentation generators). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

API documentation is a term used in computer programming. It describes the Application programming interface of a programming project, so that other programmers can continue developing in the project, or develop other software that make use of the projects API, without having to study the code itself.

API documentation is commonly published in electronic document formats such as HTML, PostScript or RTF. Many IDEs also have API Documentation as part of their help system.

There are several tools designed to automatically generate API docomentation from source code. These typically make use of some special type of code comments to generate the documentation.

See also