Mailing-List: contact cassandra-commits-help@incubator.apache.org;
 run by ezmlm
Precedence: bulk
Reply-To: cassandra-dev@incubator.apache.org
Message-ID: <1724906138.1258737760198.JavaMail.jira@brutus>
Date: Fri, 20 Nov 2009 17:22:40 +0000 (UTC)
From: "Gary Dusbabek (JIRA)" <jira@apache.org>
To: cassandra-commits@incubator.apache.org
Subject: [jira] Commented: (CASSANDRA-324) Add documentation to Thrift
 interface
In-Reply-To: <290077603.1248885134835.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


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

Gary Dusbabek commented on CASSANDRA-324:
-----------------------------------------

@param and @return look crappy in the generated HTML, as thrift doesn't appear to be doing anything with them.  Think undecorated text (or html) will work better here.

> 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: Gary Dusbabek
>            Priority: Minor
>             Fix For: 0.5
>
>         Attachments: 324-v1.patch
>
>
> 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.