cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jonathan Ellis (JIRA)" <j...@apache.org>
Subject [jira] Commented: (CASSANDRA-324) Add documentation to Thrift interface
Date Tue, 13 Oct 2009 19:56:31 GMT

    [ https://issues.apache.org/jira/browse/CASSANDRA-324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12765206#action_12765206
] 

Jonathan Ellis commented on CASSANDRA-324:
------------------------------------------

Michael Greene comments in IRC:

 /** Doctext in Thrift is specified preceding a definition like this */ struct WithDoctext
{ 1: i32 intMember }

works with methods too, the only thing I can't get it to work properly for is enums

> 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
>            Assignee: Michael Greene
>            Priority: Minor
>             Fix For: 0.5
>
>
> 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