Releases: senchalabs/jsduck
Releases · senchalabs/jsduck
3.0 pre 3 Introducing custom tags
- Completely redesigned system for defining custom tags.
- New
--images
option to replace the manual copying of images. - Support for
{@img}
tag in guides. - Listing of
requires
anduses
classes on sidebar. - Listing all source files of a class.
- Listing all types of aliases in class header.
- Support for
@evented
tag, for documenting evented@accessor
s. - Detecting of
xtype:
property insideExt.define()
. - Allow any text as a default value, for example
@param {Object} [scope=this]
didn't work before. - No more throw warnings when Mixed type is used.
- Classes containing classes treated as packages in class tree.
- Guides/videos/examples trees expanded by default.
- New
@example preview
syntax to start inline example in preview mode. - Categories file no more needs an extra surrounding
{"categories": ... }
object. - Unified formatting of warnings and other log messages.
- Improved handling of windows filenames.
- Lots of bug fixes, as always...
3.0 pre 2 Builtin JS classes and @accessor tag
- Documentation for built-in JavaScript classes like Object, Array and String. Activated with --builtin-classes option.
- Support for
@accessor
tag for use insideconfig: {}
section to auto-generate docs for getters-setters. - Support for
@template
tag for marking up template methods. - Showing author and docauthor information, plus experimental
--meta-tags
option for supporting several more. - Experimental
--ext-namespace
option - The
--json
export no more creates source dir, only one dir with .json files describing the classes. - Show ptype and ftype in addition to xtype in class header.
- Show short version of
--help
by default and long only if--help=full
. - Tabs drop-down menu with close-all-tabs button always visible.
- Fix handling of static members. Statics are now also searchable.
- Fixes for handling of paths under Windows.
- Several other minor fixes.
3.0 pre Completely new theme with tabs
- Tabs are back
- Separate front page
- Guides in separate section
- New Videos section
- New Examples section
- Inline examples
- Syntax for documenting object properties.
- Syntax for documenting default values.
- New Syntax for optional parameters.
- Syntax for required configs.
- Print view and support for Google AJAX crawling.
- No more
--show-private-classes
option, private classes now always shown. - Lots and lots of other fixes...
2.0 pre 4
- Paging of search results.
- Support opening classes in tree in new tabs in IE and Firefox.
- Include upgraded version of prettifier, fixing formatting in IE.
- New
--head-html
and--body-html
command line options. - New
--local-storage-db
command line option. - Avoid creating case-insensitively same source file names,
preventing duplicate file conflicts in Windows. - Include missing ExtJS image files.
- Don't exclude static members from singleton classes, simply print
warning about using @static in singleton class.
0.6.1
2.0 pre Completely overhauled Ext4-themed version
- A lot of changes since 0.6 releases.
2.0 pre 2
0.6 JsDuck is now used for creating the official ExtJS4 documentation
- Automatic linking of class names found in comments. Instead of writing
{@link Ext.Panel}
one can simply writeExt.Panel
and link will be
automatically created. - In generated docs, method return types and parameter types are also
automatically linked to classes if such class is included to docs. - Support for
{@img}
tag for including images to documentation.
The markup created by{@link}
and{@img}
tags can now be customized using
the --img and --link command line options to supply HTML templates. - Links to source code are no more simply links to line numbers.
Instead the source code files will contain ID-s likeMyClass-cfg-style
. - New tags:
@docauthor
,@alternateClassName
,@mixins
.
The latter two Ext4 class properties are both detected from code and
can also be defined (or overriden) in doc-comments. - Global methods are now placed to separate "global" class.
Creation of this can be turned off using--ignore-global
. - Much improved search feature.
Search results are now ordered so that best matches are at the top.
No more is there a select-box to match at beginning/middle/end -
we automatically search first by exact match, then beginning and
finally by middle. Additionally the search no more lists a lot of
duplicates - only the class that defines a method is listed, ignoring
all the classes that inherit it. - Support for doc-comments in SASS .scss files:
For now, it's possible to document SASS variables and mixins. - Several bug fixes.
0.5 Search and export
- Search from the actually generated docs (not through sencha.com)
- JSON export with --json switch.
- Listing of mixed into classes.
- Option to control or disable parallel processing.
- Accepting directories as input (those are scanned for .js files)
- Many bug fixes.
0.4 Ext4 support
- Support for
Ext.define()
syntax from ExtJS 4. - Showing
@xtype
and@author
information on generated pages. - Showing filename and line number in warnings.
- Fix for event showing the same doc as method with same name.