You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@aurora.apache.org by "Bill Farner (JIRA)" <ji...@apache.org> on 2014/11/24 21:29:13 UTC
[jira] [Created] (AURORA-947) Use thrift's built-in doc generator
Bill Farner created AURORA-947:
----------------------------------
Summary: Use thrift's built-in doc generator
Key: AURORA-947
URL: https://issues.apache.org/jira/browse/AURORA-947
Project: Aurora
Issue Type: Task
Components: Documentation
Reporter: Bill Farner
Priority: Minor
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.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)