cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Greene (JIRA)" <j...@apache.org>
Subject [jira] Created: (CASSANDRA-324) Add documentation to Thrift interface
Date Wed, 29 Jul 2009 16:32:14 GMT
Add documentation to Thrift interface
-------------------------------------

                 Key: CASSANDRA-324
                 URL: https://issues.apache.org/jira/browse/CASSANDRA-324
             Project: Cassandra
          Issue Type: Improvement
          Components: Documentation & website
            Reporter: Michael Greene
            Priority: Minor
             Fix For: 0.4


We should be using the doctext feature of Thrift to document all of our enums, structs, and
services.

Rather than leaving individual wrapper libraries to document the interface, it should be consolidated
into one place (the .thrift file).  It can then be used to generate javadocs for the stuff
that gets placed in gen-java, documentation for the Thrift-generated client libraries, or
generate nifty html using Thrift's own --gen html.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message