2.1.0 – Polite Little Squid

• A @name annotation has been added to make it possible to override an item's name (#358)
• A privatePrefix option has been added to make it possible to autofill @access (#357)
• description and descriptionPath options have been added to make it possible to provide a project wide description, as direct Markdown or a Markdown file (#256)
• A sort option has been added to make it possible to order items based on a couple of criterias (#239)

2.0.5

• Fix an issue with relative path passed via CLI and configuration file (#364, c47dea1)

2.0.2

• Move to 6to5 3 in selfContained mode to avoid global scope pollution (#354)

2.0.0 – Shiny Streamy Octopus

API breaks for users

• C-style comments (/** */) are no longer supported (#326)
• SassDoc now always outputs its own directory in the current folder (#302)
• --dest option has been added to define SassDoc's folder path for output, default is sassdoc (#302)
• --no-prompt option no longer exists since SassDoc outputs its own folder (#302)
• --sass-convert option no longer exists and is now implied (#231)
• Default name for configuration file is now .sassdocrc (#189)
• @alias can no longer be used on placeholders (#263)
• Annotations @access, @content, @deprecated, @group, @output, @return and @type are now restricted to one use per item (#257)
• Annotations @param and @prop now use square brackets ([]) for default values rather than parentheses (()) to avoid edge issues (#303)
• See UPGRADE-2.0.md to convert all your SassDoc comments.

API breaks for theme builders

• sassdoc-filter and sassdoc-indexer repositories no longer exist and have been replaced by sassdoc-extras
• sassdoc-theme-light repository no longer exists and has been replaced by sassdoc-theme-default
• html* properties no longer exist when using Markdown filter from sassdoc-extras, initial values are now overwritten (sassdoc-extras#6)
• @return no longer returns a name and a default value, only a type and a description (#277)
• @content no longer returns an autogenerated key, only a description (#262)
• parameters key from item now becomes parameter (#225)
• requires key from item now becomes require (#225)
• returns key from item now becomes return (#225)
• throws key from item now becomes throw (#225)
• todos key from item now becomes todo (#225)
• prop key from item now becomes property (#225)
• When using the display filter from sassdoc-extras, items are now fully removed rather than given a display key (sassdoc-extras#11)

API breaks for third party integration

• The node API has been revamped and unified.
  • sassdoc.documentize does not exist anymore.
  • sassdoc(src [, config]) execute the full Documentation process, returns a Promise.
  • sassdoc([config]) execute the full Documentation process, returns a Stream of Vinyl files.
  • sassdoc.parse(src [, config]) returns a Promise with the full data object.
  • sassdoc.parse([config]) returns a Stream with the full data object.

New features

• The whole API has been fully refactored in ES6 (#231)
• $ sign is now optional when defining the name in @parameter annotation (#222)
• It is now possible to use file/folder exclusion patterns (#228)
• It is now possible to pipe SassDoc into stdin (#315)
• --debug option has been added to output information about current setup (#311)
• Default theme now has a googleAnalytics configuration accepting a Google Analytics tracking key (sassdoc-theme-default#10)
• Default theme now has a trackingCode configuration accepting an arbitrary HTML snippet to be included before </body> (sassdoc-theme-default#10)
• @content annotation is now correctly output in default theme (sassdoc-theme-default#15)
• Default theme now displays the type as well as the name when cross-linking items (requirements, and so on...) (sassdoc-theme-default#17)
• Error messages should now be more explicit, providing a file name and a line (#282)
• --parse option has been added to output raw parsing data as JSON from the CLI (#318)

Bug fixes

• Autofill no longer capture @throw that are already defined with annotations (#270)
• Variables view source link now correctly supports start and end lines in default theme (sassdoc-theme-default#21)
• Empty groups are no longer displayed in default theme (sassdoc-theme-default#20)
• Variable content is no longer displayed as safe in (sassdoc-theme-default#19)
• @since description is now parsed as Markdown in the default theme (sassdoc-extras#8)
• @deprecated description is now parsed as Markdown in the default theme (sassdoc-extras#7)

2.0.1

Fix debug task name

Since `documentize` is an async function, it was in fact a 6to5 wrapper
and not the original named function, thus `task.name` was returning a
funny name like `callee$1$0`.

This fix ensures the right name is displayed.

1.10.6

• Ensure proper type checking for @see annotation (#291)

1.10.3

• Prevented @requires to autofill dependency twice

1.10.2

• Fixed an issue with the folder wiping safeguard always aborting if folder is not empty without even prompting

1.10.1

• Updated a dependency in order to use new version of sassdoc-theme-default

1.10.0

• Made annotations @throws, @requires and @content fill themselves so you don't have to, unless told otherwise through the autofill option (#232, #238)
• Added the ability to define --sass-convert, --no-update-identifier and --no-prompt options within the configuration file instead of CLI only (#247)
• Merged sassdoc-filter and sassdoc-indexer into sassdoc-extras; theme authors are asked to use the new repository