Changelog
2.0.1
task.name
value, returning proper function name instead of something like callee$1$0
.Changelog
2.0.0 — Shiny Streamy Octopus
/** */
) are no longer supported (#326)--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).sassdocrc
(#189)@alias
can no longer be used on placeholders (#263)@access
, @content
, @deprecated
, @group
, @output
, @return
and @type
are now restricted to one use per item (#257)@param
and @prop
now use square brackets ([]
) for default values rather than parentheses (()
) to avoid edge issues (#303)UPGRADE-2.0.md
to convert all your SassDoc comments.sassdoc-filter
and sassdoc-indexer
repositories no longer exist and have been replaced by sassdoc-extrassassdoc-theme-light
repository no longer exists and has been replaced by sassdoc-theme-defaulthtml*
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)display
key (sassdoc-extras#11)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.$
sign is now optional when defining the name in @parameter
annotation (#222)stdin
(#315)--debug
option has been added to output information about current setup (#311)googleAnalytics
configuration accepting a Google Analytics tracking key (sassdoc-theme-default#10)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)--parse
option has been added to output raw parsing data as JSON from the CLI (#318)@throw
that are already defined with annotations (#270)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)