STC Summit 2016 has ended
Back To Schedule
Monday, May 16 • 9:45am - 10:30am
Generating API Documentation Automatically from the Source Code

Sign up or log in to save this to your schedule, view media, leave feedback and see who's attending!

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.

avatar for Ed Marshall

Ed Marshall

Marshall Documentation Consulting
Ed is an independent consultant technical writer and the sole proprietor of Marshall Documentation Consulting, with over 28 years in technical writing. He specializes in technical documentation for developers including APIs (application programming interfaces), SDKs (software developer’s... Read More →

Monday May 16, 2016 9:45am - 10:30am PDT
Platinum 2