[
https://issues.apache.org/jira/browse/THRIFT-681?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Bryan Duxbury updated THRIFT-681:
---------------------------------
Attachment: thrift-682-v2.patch
I just spent a few minutes fixing the spacing and reviewing the v2 patch to
come up with this cleaner version. But then I realized that we hadn't come to a
clear conclusion as to whether we wanted to encourage the "@param in above
block" or "comments on individual elements" doc style.
> The HTML generator does not handle JavaDoc style comments very well
> -------------------------------------------------------------------
>
> Key: THRIFT-681
> URL: https://issues.apache.org/jira/browse/THRIFT-681
> Project: Thrift
> Issue Type: Improvement
> Components: Compiler (General)
> Affects Versions: 0.2
> Reporter: John Bartak
> Assignee: Bryan Duxbury
> Attachments: Screenshot.png, screenshot-1.jpg,
> t_html_generator_JavaDoc.patch, t_html_generator_JavaDoc.v2.patch,
> thrift-682-v2.patch
>
>
> If you create comments using the standard JavaDoc conventions of @param and
> @exception, the output that gets generated isn't the cleanest. It would be
> better if the list of parameters and exceptions were placed in a table with
> the appropriate headers rather than just outputting the @param and @exception
> tags into the HTML output.
--
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
