vscode-solargraph icon indicating copy to clipboard operation
vscode-solargraph copied to clipboard

Line breaks in Ruby source doc comments

Open derkallevombau opened this issue 4 years ago • 1 comments

  • <br>: Works in overview for hover and doc page. Also works in @param description for doc page, but hover prints <br> instead of inserting a line break.
  • \: Works in @param description for hover, but doc page prints \ instead of inserting a line break. When used in overview, both hover and doc page print \.

It would be great if one of these worked generally, preferably <br>, but \ would do it as well.

However, thank you for this awesome extension!

derkallevombau avatar Mar 12 '20 21:03 derkallevombau

I'm not sure if this feature will be supported or not. The typical use case for @param text is a brief description, not more than 1 or 2 lines. If you need more than that, it probably belongs in the method documentation body.

castwide avatar May 03 '20 06:05 castwide