mryozo16 / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

documentation across multiple lines #133

Closed GoogleCodeExporter closed 8 years ago

GoogleCodeExporter commented 8 years ago
What steps will reproduce the problem?
1.  Having documentation that spans multiple lines, where there is a new
line \n at the end

What is the expected output? What do you see instead?
Well, is there a way to set this to replace new lines in documentation with
<br>'s, so it shows up proper in the docs? Currently it just compresses it
all into 1 big paragraph. so... if(documentation) \n -> <br>

What version of the product are you using? On what operating system?
1.4

Original issue reported on code.google.com by mou...@gmail.com on 25 Apr 2008 at 9:34

GoogleCodeExporter commented 8 years ago
There may be a way to automatically replace newlines with the HTML tag for line 
break, but that is not 
necessarily what every user wants: not all JsDoc output goes into web pages. 
I'd prefer to leave it to those that 
do want <br> tags to simply add them directly:

/**
This is <br>
a multiline comment.
*/

Original comment by micmath on 26 May 2008 at 10:54