You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "Kevin Burnett (JIRA)" <ji...@apache.org> on 2012/05/01 21:28:49 UTC
[jira] [Updated] (THRIFT-681) The HTML generator does not handle
JavaDoc style comments very well
[ https://issues.apache.org/jira/browse/THRIFT-681?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kevin Burnett updated THRIFT-681:
---------------------------------
Attachment: thrift-681-inline-parameter-doc-generation.png
thrift-681-inline-parameter-doc-generation.patch
Attached please find a patch that applies cleanly to http://svn.apache.org/repos/asf/thrift/trunk@1332766 and implements the "comments on individual elements" style of html generation. The screenshot demonstrates the parameter documentation created by thrift -gen html test/DocTest.thrift. Exceptions with documentation also appear in table format in the generated html documentation. Note that a minified version of bootstrap.css (apache licensed) has been bundled as well in order to spruce up the css styles. I worked with a colleague, Kevin Radloff (radsaq), on these changes. Thanks for thrift!
> 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
> Attachments: Screenshot.png, screenshot-1.jpg, t_html_generator_JavaDoc.patch, t_html_generator_JavaDoc.v2.patch, thrift-681-inline-parameter-doc-generation.patch, thrift-681-inline-parameter-doc-generation.png, 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.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira