aurora-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bill Farner (JIRA)" <>
Subject [jira] [Updated] (AURORA-947) Use thrift's built-in doc generator
Date Thu, 04 Dec 2014 00:37:12 GMT


Bill Farner updated AURORA-947:
    Sprint: Twitter Aurora Q4 Sprint 5

> Use thrift's built-in doc generator
> -----------------------------------
>                 Key: AURORA-947
>                 URL:
>             Project: Aurora
>          Issue Type: Task
>          Components: Documentation
>            Reporter: Bill Farner
>            Assignee: Bill Farner
>            Priority: Minor
> We currently have a custom API documentation generator in {{src/main/python/apache/aurora/tools/java/}}.
 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

View raw message