[
https://issues.apache.org/jira/browse/THRIFT-681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12803158#action_12803158
]
Lars Francke commented on THRIFT-681:
-------------------------------------
About the duplicated parameters: Have a look at the file David pointed out to
you. It shows how function parameters ought to be documented.
I'm using the comment style from the DocTest.thrift but there is no
documentation generated for function parameters either:
{noformat}
/**
* Disables a table (takes it off-line) If it is being served, the master
* will tell the servers to stop serving it.
*/
void disableTable(
/** name of the table */
1:Bytes tableName
) throws (1:IOError io)
{noformat}
It would be nice if this format would be supported by the HTML compiler. The
output your patch produces looks very nice. I think it would be good if that
patch was adapted so it uses this "official" documentation style. It would be
even nicer if this style was documented somewhere outside of the test. I'll try
to find a place in the wiki tomorrow where this fits.
> 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
> Attachments: screenshot-1.jpg, t_html_generator_JavaDoc.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.
-
You can reply to this email to add a comment to the issue online.
