Releases: senchalabs/jsduck
Releases · senchalabs/jsduck
3.6.0 @hide and @ignore no more equivalent to @private
@hide
now only hides parent class members.@ignore
completely ignores member of whole class.pri
,pro
,dep
, ... labels in search results.- Icons for CSS mixins and variables.
- Better icon management for guides.
- Fix crash when
@cfg
default value isnull
.
3.5.0 Lots of work around toggling @deprecated and @removed
- Support for
@removed
tag. - Support for
@aside
tag (this should be considered experimental for now). - Custom tags can now
position
themselves above or below other content. - Custom tags can now access guides/examples/videos/... through
@assets
. - Videos and examples JSON can now define "name" field which is used for better URL-s.
- Videos JSON structure unified with other configs. ("description" instead of "desc", "title" instead of "text", but the old field names will keep on working still).
- Mixins list separated to "Mixins" and "Inherited mixins".
- Warnings when mixins, requires, or uses classes are missing.
@deprecated
and@removed
members hidden by default, but can be toggled through "show" menu.- Member menus adjust to viewport height, making better use of available space.
- Member menus fully alphabetically sorted (static members no more at the end).
- Required config options listed before optional ones on page.
- "CSS Vars" and "CSS Mixins" menus on toolbar.
- "Subclasses" and "Mixed into" moved from toolbar to sidebar.
- New --examples-base-url option to define where examples are located.
- Allow absolute URL-s for examples.
- Lots of various fixes.
3.4.1
- Fix @deprecated tag in class context.
3.4.0 Toggling of private classes and members.
- Private members (those documented with
@private
,@hide
,@ignore
) now also included to docs. - New menu to toggle public/protected/private members and also inherited members and accessors.
- Table of Contents for each guide.
- Few minor fixes.
3.3.1
3.3.0
- New warning for duplicate member names.
- Info about overridden members in parent class.
- Redirect alternate classnames to canonical ones.
- Detect doc-comment before
Ext.emptyFn
as method. - Allow configs to begin with uppercase letter.
- Preserve the order of members not belonging to classes.
- Fix crash when string "function" after doc-comment.
- Fix crash when documenting anonymous function.
- Fix hiding of parent members by
@private
in subclass.
3.2.1 Config file, auto-linking, extra warnings.
- Better automatic linking of class and member names.
- Search now correctly works for alternateClassNames and aliases.
- New
--config
option for loading JSDuck options from JSON file. - Support for loading list of input files from JSB file.
- Support for
@readonly
,@abstract
and@preventable
tags. - New warning types:
link_private
,link_ambiguous
,link_auto
,no_doc
. - Explicit links to static members using
{@link #static-foo}
. - Improved meta-tags system.
- Several builtin tags are now implemented as meta-tags:
@static
,@protected
,@deprecated
,@template
.
This means that in the JSON output these tags can be now found inmeta
section. - Bunch of bug fixes etc.
3.1.0 Granular warnings
- Granular on/off switching of warnings.
- New
--export
option which replaces--json
and--stdout
.
The--stdout
functionality is achieved by--output=-
. - New
@inheritdoc
tag which replaces@alias
.
The new role of alias is to define class aliases like
@alias widget.grid
; for backwards compatibility it
still works for inheriting docs. - New
@uses
and@requires
tags to complement the
auto-detection ofuses:
andrequires:
insideExt.define
. - Private members now hide public members of parent class.
- Larger buttons above inline examples for switching
between code editor and preview. - Members of current class now visually distinct.
- Allow use of user-defined meta-tags in members.
- Warning when class name matches alternate class name.
- Better class tree expansion when multiple root namespaces.
- Fix auto-detecting default cfg value if it's expression.
- Fix toolbar and button backrounds for Opera.
- TypeKit font loaded asynchronously to allow better offline experience.
- CSS fixes for IE and Opera.
- Exclude unneccessary files from JSDuck output.
- Experimental
--stats
option for generating some statistics. - Lots of internal code cleanup.