[jira] [Updated] (AURORA-947) Use thrift's built-in doc generator

["Maxim Khutornenko (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/AURORA-947?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Maxim Khutornenko updated AURORA-947:
-------------------------------------
    Fix Version/s: 0.7.0

> 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
>            Assignee: Bill Farner
>            Priority: Minor
>             Fix For: 0.7.0
>
>
> 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)