croquiscom/crojsdoc

multiline @param @return etc.

stuikomma opened this issue · 0 comments

I have not found a way to write a description for a return value in multiple lines. I'm using coffeescript.

###
# This function does something.
# This is also part of the description which is no problem.
# 
# @return {String} This is a very long description that spans
# multiple lines for better readability.
###

It results in the description being truncated after ... spans.