[
https://issues.apache.org/jira/browse/CASSANDRA-324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12775940#action_12775940
]
Jonathan Ellis commented on CASSANDRA-324:
------------------------------------------
ok, i will buy the "optimize for html" argument, but let's at least make it as
readable as possible in text (format the html consistently one tag per line,
don't mix tabs in the spaces, etc)
but if we're going to do that the corollary seems to be "might as well use html
for the structs, too," no?
> 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.
