aurora-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Bill Farner (JIRA)" <>
Subject [jira] [Created] (AURORA-947) Use thrift's built-in doc generator
Date Mon, 24 Nov 2014 20:29:13 GMT
Bill Farner created AURORA-947:

             Summary: Use thrift's built-in doc generator
                 Key: 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/}}.
 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