7.4 Line wrapping

Line-wrapped block tags are indented four spaces. Wrapped description text maybe lined up with the description on previous lines, but this horizontalalignment is discouraged.

  1. /**
  2.  * Illustrates line wrapping for long param/return descriptions.
  3.  * @param {string} foo This is a param with a description too long to fit in
  4.  *     one line.
  5.  * @return {number} This returns something that has a description too long to
  6.  *     fit in one line.
  7.  */
  8. exports.method = function(foo) {
  9.   return 5;
  10. };

Do not indent when wrapping a @desc or @fileoverview description.