You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/05/11 15:22:12 UTC
[jira] [Commented] (THRIFT-3823) Escape documentation while
generating non escaped documetation
[ https://issues.apache.org/jira/browse/THRIFT-3823?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15280278#comment-15280278 ]
ASF GitHub Bot commented on THRIFT-3823:
----------------------------------------
GitHub user hush-hush opened a pull request:
https://github.com/apache/thrift/pull/1009
THRIFT-3823: Use 'pre' HTML tag when generating non escaped documentation.
This allow clearer documentation and avoid adding HTML tag in the .thrift comments to generate readable HTML.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/hush-hush/thrift master
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/thrift/pull/1009.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #1009
----
commit c41a292c68c1fd43019f0af6faa94cc57fe57050
Author: Maxime Mouial <ma...@scmfrance.fr>
Date: 2016-05-11T15:07:53Z
Use 'pre' HTML tag when generating non escaped documentation.
This allow clearer documentation and avoid adding HTML tag in the .thrift comments to generate readable HTML
----
> 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
>
> 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.4#6332)