STC Summit 2016

Many developers who produce application programming interfaces (APIs) prefer to generate the documentation directly from the source code. This session explores and demonstrates three commonly-used tools used for this: Doxygen for C-like APIs, Javadoc for Java APIs, and Swagger for Web Service APIs. We will cover how these tools work conceptually and describe the standard outline for API reference information, which is expected by software developers. We will also review the coding used for each tool to produce the organization of API reference information, and show examples of “pushing the limits” of these tools to include content that is more than the standard programming reference information.