cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Gary Dusbabek (JIRA)" <>
Subject [jira] Updated: (CASSANDRA-324) Add documentation to Thrift interface
Date Fri, 20 Nov 2009 17:58:39 GMT


Gary Dusbabek updated CASSANDRA-324:

    Attachment: 324-v2.diff

Added doc to new stuff, create tables for remaining structs, and wrapped lines.

I'm forgoing the @param, @return stuff because it looks way crappy in the HTML.

> Add documentation to Thrift interface
> -------------------------------------
>                 Key: CASSANDRA-324
>                 URL:
>             Project: Cassandra
>          Issue Type: Improvement
>          Components: Documentation & website
>            Reporter: Michael Greene
>            Assignee: Gary Dusbabek
>            Priority: Minor
>             Fix For: 0.5
>         Attachments: 324-v1.patch, 324-v2.diff
> 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.

View raw message