[
https://issues.apache.org/jira/browse/THRIFT-6038?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Jens Geyer resolved THRIFT-6038.
--------------------------------
Fix Version/s: 0.24.0
Assignee: Jens Geyer
Resolution: Fixed
> Markdown generator: use .md extension by default and render @param/@return
> tags as table
> ----------------------------------------------------------------------------------------
>
> Key: THRIFT-6038
> URL: https://issues.apache.org/jira/browse/THRIFT-6038
> Project: Thrift
> Issue Type: Improvement
> Components: Markdown - Compiler
> Reporter: Jens Geyer
> Assignee: Jens Geyer
> Priority: Minor
> Fix For: 0.24.0
>
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Two improvements to the Markdown code generator (t_markdown_generator.cc):
> 1. *Default .md extension*: Output files now use the .md extension by
> default. Previously the generator produced extension-less files unless the
> {{suffix}} option was explicitly set. The {{suffix}} option continues to work
> as an override; {{suffix=}} (empty value) can now also be used to explicitly
> suppress any extension.
> 2. *@param / @return table rendering*: When a function doc-comment contains
> {{@param}} or {{@return}} tags (at the start of a line, after optional
> whitespace), those entries are now rendered as a Markdown table rather than
> being emitted as inline prose mixed with the description. This matches the
> common Javadoc-style convention used in ThriftTest.thrift and other IDL
> files. Tags embedded in mid-line prose (e.g. email addresses) are not
> affected. Multi-line tag descriptions (continuation lines before the next tag
> line) are joined into a single table cell. Pipe characters in cell content
> are escaped to protect the table structure.
> A test fixture (DocTest.thrift), a golden reference file (DocTest.md), and a
> Python unittest script are added, with the test registered in the CMake build.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
