The script can’t handle all the possible edge cases, so please make sure
to run it in a version-controlled environment, and review carefully the
changes.

You’ll also have to manually fix all your poster comments by hand
since there is no way for this script to convert them accurately; only
the closing can be converted, but you’ll need to add a / to all poster
openings.

If you want to know more on what’s happening in these cryptic sed
commands, here is the commented sed source:

# Opening (can't determine if poster or normal)s,^/\*\*,///,

# Poster closings,^ *\*\*/,////,

# Normal closings,^ *\*/,///,

# Comment bodys,^ *\*,///,

Annotations

The default value of some annotations is now inside square brackets
instead of parentheses. This affects @param and @prop.

Before:

/// @param {String} $foo (bar) - Baz.@functionbaz($foo){}

After:

/// @param {String} $foo [bar] - Baz.@functionbaz($foo){}

You can use the following script to update your codebase, though
it will replace all the parentheses by square brackets in the lines
containing the affected annotations, which may not be what you want
(for example if there’s parentheses inside the default value or in
the description).

Be sure to review the changes made by the script and eventually fix
details by hand.

Gulp

Starting from version 2.0 SassDoc core is fully Gulp compatible, and can be directly
integrated in any Vinyl files pipeline. The Gulp plugin is now deprecated.
Refer to the documentation for full examples.

Similarly to any Gulp plugin, passing a directory path to gulp.src won’t work anymore.
You have to pass in glob patterns: 'source/**/*.scss'