[
https://issues.apache.org/jira/browse/CASSANDRA-324?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12775938#action_12775938
]
Gary Dusbabek commented on CASSANDRA-324:
-----------------------------------------
html - we need to decide if we'd rather have human readable code or pretty html
generation. From a java perspective, html makes sense because most java devs
(this java dev) prefers looking up the javadoc as opposed to reading it in the
code (for navigation purposes). I can see how that is less convenient for
python though. I think we should write doc strings with the intention that
most people will read them in the thrift-generated html (as opposed to javadoc
or python docs).
structs - plain text.
> 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.
