[ 
https://issues.apache.org/jira/browse/THRIFT-681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12802457#action_12802457
 ] 

John Bartak commented on THRIFT-681:
------------------------------------

The section from the .thrift file that generated the attached screenshot:

        /** 
        * Changes a message's status
        * @param personId the person changing the status
        * @param messageId the message to change the status of
        * @param newStatus the new status of the message
        * @exception AccessDeniedException thrown if the person does not have 
access to the message
        */
        void UpdateMessageStatus(1:string personId,2:string 
messageId,3:MessageData.Status newStatus) throws(1:Shared.SocialException 
socialError,2:Shared.SocialDatabaseException 
databaseError,3:Shared.BadRevisionException 
revisionException,4:Shared.ResourceNotFoundException 
notFoundException,5:Shared.AccessDeniedException accessError),
        

> 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.

Reply via email to