March 15, 2017 - 2:00 PM
March 15, 2017 - 3:00 PM
Generating API Docs Automatically from the Source Code
Documenting APIs (application programming interfaces) presents a problem that will occur in any group, no matter how well-meaning or conscientious the development and writing teams are. Sooner or later, the code will diverge from the documentation. Many developers favor an approach, coined using the “Single Source of Truth”. This means generating the documentation directly from the source code using specially formatted comments in the code. Historically, this approach has only been used to generate reference information. However, you can extend the tools used to extract the comments and generate both your reference documentation and conceptual, getting started information, and flowcharts.
This webinar will introduce and demonstrate three tools commonly used to generate reference documentation from the code. It will also show how you can use a “fill in the blank” template to produce quality API reference and conceptual/”getting started” documentation that developers will use and respect:
- Doxygen – Used primarily for C APIs
- Javadoc – Used primarily for Java APIs
- Swagger – Used primarily for REST APIs
By learning how to use tools such as Doxygen, Javadoc, and Swagger, which extract specially formatted comments from the code, we enhance our value to our organizations and to our users, software developers. More specifically, we qualify ourselves to opportunities offering higher pay and prestige within software development teams.
Frequently Asked Questions
When do education events take place?
Webinars are held every Wednesday afternoon from 2-3 PM EDT/EST (GMT-4/5).
A majority of online courses are held Tuesdays-Thursdays between 10:00 AM-1:00 PM EDT/EST (GMT-4/5), as to not conflict with webinar times.
When will I receive the Adobe Connect instructions for an event?
Registered attendees will receive the Adobe Connect instructions three (3) hours before the webinar begins, approximately at 11:00 AM EDT/EST.
Registered attendees will receive the Adobe Connect instructions one (1) day before the online course begins.
To participate in a webinar and an online course, you must be able to access Adobe Connect, STC’s online meeting space. You can test your Adobe Connect connection here. Adobe Connect is a standard web seminar tool (no separate download required) and all you need is a reliable Internet connection and phone line, or a computer with VoIP capabilities.
I registered for an online course, what are my next steps?
Once you register for an online course, you will receive a confirmation receipt that day. A majority of our online courses uses Moodle, STC’s course management site, which attendees will receive the login instructions two (2) days before the course begins.
If you cannot access Adobe Connect and/or Moodle (as needed), then you will not be able to successfully complete an online course.
I registered for a webinar, but will be unable to attend. Will a recording be available?
If a registered attendee is unable to attend a webinar that day, they will receive an email with a link to the recording, and an evaluation link along with the PDF of the presentation.
I registered for a webinar and/or an online course, but cannot attend at that time. Will I receive a refund?
If a registered attendee is unable to attend a webinar and/or an online course, the cost is transferable to a future event, but is not refundable. Online registration closes one-two business days before the education event begins.
I want to take a specific course that isn't listed online. Will it be offered in the future?
STC rotates its courses every year as we try to offer the most popular ones within the first half of the year. Online courses are subject to change or are offered more than once per quarter. If a course is not listed, STC will offer it again in the following year.
Have an Education Question? Contact Us!