[
https://issues.apache.org/jira/browse/THRIFT-681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12802424#action_12802424
]
David Reiss commented on THRIFT-681:
------------------------------------
See test/DocTest.thrift for the proper way of documenting parameters. We don't
have an example for exceptions, but they work the same way.
> 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
> Affects Versions: 0.2
> Reporter: John Bartak
>
> 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.
-
You can reply to this email to add a comment to the issue online.
