Render newlines as separate paragraphs #380
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Line breaks in Doxygen documentation are not being rendered correctly.
Given the following C++ class definition
The corresponding XML output for the
bar
data member isThe
<linebreak/>
tags, which appear as newline characters in the nodeargument's text in the call to
SphinxRenderer.visit_unicode
, do not getrendered as paragraphs. The corresponding Sphinx HTML is
This commit wraps each line in multiline comments in a paragraph so it gets
rendered correctly. After applying this change, the Sphinx HTML is rendered as
follows