[AURORA-947] Use thrift's built-in doc generator

• Type: Task
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 0.7.0
• Component/s: Documentation
• Sprint: Twitter Aurora Q4 Sprint 5
• Assignee: Bill Farner
• Reporter: Bill Farner
• Created: 24/Nov/14 20:29
• Updated: 26/Jan/15 22:58
• Resolved: 05/Dec/14 02:10

Description

We currently have a custom API documentation generator in src/main/python/apache/aurora/tools/java/thrift_wrapper_codegen.py. As it turns out, thrift has built-in support for this when invoked with --gen html. From a quick glance, it picks up ~all of our javadoc-style docstrings and displays them nicely in the generated output. My attempts to find documentation for the doc syntax in thrift failed (the irony), but it appears at least javadoc-style comment blocks are captured.

We should consider our doc generator deprecated and switch to this as soon as it is practical.