[
https://issues.apache.org/jira/browse/THRIFT-3823?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15953148#comment-15953148
]
ASF GitHub Bot commented on THRIFT-3823:
----------------------------------------
Github user hush-hush commented on the issue:
https://github.com/apache/thrift/pull/1029
OK, closing the PR.
> Escape documentation while generating non escaped documetation
> --------------------------------------------------------------
>
> Key: THRIFT-3823
> URL: https://issues.apache.org/jira/browse/THRIFT-3823
> Project: Thrift
> Issue Type: Improvement
> Components: Compiler (General)
> Affects Versions: 0.9.3
> Reporter: maxime mouial
> Assignee: James E. King, III
> Priority: Minor
> Fix For: 0.11.0
>
>
> The HTML generated documentation from a .thrift don't format comments. They
> all appears as a one-liner.
> When not using the "noescape" tag, documentation comments should be displayed
> between "<pre>" tag to keep readability.
> This will allow comment such as this one to be displayed correctly (and not
> on one line):
> {code}
> /**
> * This method is doing this and that.
> *
> * @param user
> * Current identifier of the user
> *
> * @param password
> * Some password
> *
> * @return
> * Some data
> *
> * @throws ExceptionA
> * @throws ExceptionB
> */
> string doSomeStuff(
> 1: string user,
> 2: string pasword,
> ) throws (
> 1: ExceptionA userException,
> 2: ExceptionB systemException,
> )
> {code}
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
