Return-Path: Delivered-To: apmail-incubator-cassandra-commits-archive@minotaur.apache.org Received: (qmail 26914 invoked from network); 29 Jul 2009 16:32:39 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.3) by minotaur.apache.org with SMTP; 29 Jul 2009 16:32:39 -0000 Received: (qmail 77987 invoked by uid 500); 29 Jul 2009 16:32:40 -0000 Delivered-To: apmail-incubator-cassandra-commits-archive@incubator.apache.org Received: (qmail 77955 invoked by uid 500); 29 Jul 2009 16:32:40 -0000 Mailing-List: contact cassandra-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: cassandra-dev@incubator.apache.org Delivered-To: mailing list cassandra-commits@incubator.apache.org Received: (qmail 77822 invoked by uid 99); 29 Jul 2009 16:32:39 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 29 Jul 2009 16:32:39 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.140] (HELO brutus.apache.org) (140.211.11.140) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 29 Jul 2009 16:32:36 +0000 Received: from brutus (localhost [127.0.0.1]) by brutus.apache.org (Postfix) with ESMTP id CC47A234C044 for ; Wed, 29 Jul 2009 09:32:14 -0700 (PDT) Message-ID: <290077603.1248885134835.JavaMail.jira@brutus> Date: Wed, 29 Jul 2009 09:32:14 -0700 (PDT) From: "Michael Greene (JIRA)" To: cassandra-commits@incubator.apache.org Subject: [jira] Created: (CASSANDRA-324) Add documentation to Thrift interface MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 X-Virus-Checked: Checked by ClamAV on apache.org 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.