Bugfixes
- Inline annotations will now be ignored by default. E. g. for this annotation
were created a member in the corresponding namespace
/** @type {string} */ var fuu = "bar";
- Fixed errors in log messages
- Module types were not parsed correctly ( #39 and #52)
- Support for
@extends - Fixes for resolving memberships in classes
- Property params of type arrays caused an exception while generating the definition file
/** * @param {object[]} fuu * @param {string} fuu[].bar <= Caused exception */
- In some cases, type
nullcaused exceptions
New features in this release:
- Type definitions != object will be transformed to type declarations, e. g.
will be transformed to
/** @typedef {string|number} NumberLike */declare type NumberLike: string|number;
- Support for annotation
@this(#54) - Support for annotation
@hideconstructor(#53) - Support for annotation
@extends(#56) - Undocumented members will be skipped by default (can be configured)
- Possibility to disable the since-tag check
Bugfixes
New features in this release:
- Support for object key and property description (see #25)
Bugfixes:
- Generic types were not mapped correctly, e.g.
were mapped to
/** * @function f1 * @param {Promise<*>} myParam */
which is not valid typescript (see #38)f1(myParam: Promise.<*>)
Bugfixes:
- Modules can now contain unexported members. You can use the @inner and @static annotation to control the scope of module members
Bugfixes:
- Nested arrays were not mapped correctly, e.g.
- Arrays with union types were not mapped correctly
New features in this release:
- The config property
ignorePrivateMemberswas removed. Instead we use jsdoc provided functionality to identify if private members should be omitted or not. More concretely: Private members will be now omitted by default unless you pass the parameter--privateto your jsdoc call. An example call could look like$> jsdoc -r src -t node_modules/@otris/jsdoc-tsd --private - When the parent item of an item was missing (e.g. because of a typo), the item was added as a top level declaration. We decided to omit such items and display a warning instead
Bugfixes:
- There were some issues parsing the jsdoc comments (especially for multi line comments).
We fixed that by using "comment-parser" for parsing the jsdoc comment. Now the following
tags will be displayed, everything else will be omitted:
- author
- copyright
- deprecated
- example
- returns
- see
- throws
- todo
- param
- tutorial
- variation
- version
- license
New features in this release:
- Support for constants in namespaces
- Support for type annotations for objects of array-parameters, e.g.
/** * Assign the project to a list of employees * @param employees - The employees who are responsible for the project * @param employees[].name - The name of an employee * @param employees[].department - The employee's department */
Bugfixes:
- The description of the return value will no longer be omitted
Bugfixes:
- You can now use the template with grunt or simply use the module path as for the template parameter for jsdoc (#1)
- The description of an jsdoc item was not added if the @description-annotation was omitted
New features in this release:
- New annotations: @callback, @template
- The @return(s) annotation will no longer be omitted
Bugfixes:
- Enums were not added to namespaces
- Childrens of ignored or private members were not ignored
- Annotations with no value will be skipped
New features in this release:
- You can ignore private members by default by adding the property "ignorePrivateMembers" to the jsconfig.json
Bugfixes:
- Not all supported items were added to their parent member
New features in this release:
- You can outsource the since tag comparator function to an external file and pass that file instead of the string representation of the function
- Constructors and functions can now be overloaded
- Added support for the
@classdesctag
Bugfixes:
- Module members will be exported by default, if the private-tag is not set
- If the since-tag contains a two-digit number, the comparison was wrong. Now we use the module
node-version-comparefor the comparison - If an item was omitted because of the since tag, the members were be added still to the global namespace (if it doesn't failed). Now, the members of an omitted element will be omitted too
New features in this release:
- Support for modules (only function and variable declarations)
- Option to ignore specific scopes (see (README)[README.md])
- Option to filter the output with the @since-Tag (see (README)[README.md])
- Support for type parameters (parameters with properties)
Bugfixes:
- Items, which were annotated with @ignore were not ignored
- Fixed some log messages in error cases
- Type
functionwill no be mapped toFunction
New features in this release:
- Support for multiple parameter types
- The following tags are now supported
- @ignore
- @interface
- Declaration and parameter flags are now fully supported (public, private, protected...)
- You can pass the output path to jsdoc by passing the parameter "-d" to the cmd call (the usage is described in the README)
Bugfixes:
- The emitting of the results could abort with an uncaught exception. We now catch all uncaught exceptions and write the error to the console
- Tags with multiple lines in the jsdoc description were not correctly parsed
Other changes:
- Function return values, parameters etc. which have multiple types will now be resolved to union types
New features in this release:
- For classes the constructor will be added now
- Support for optional properties / parameters
New features in this release:
- The template supports now the tag @class for generating class definitions
- The template supports now the tag @member for class members, enum members etc.
Bugfixes:
- Changed the log message for trying to add members to an unsupported member. Before, the log message was mistakenly 'Missing top level declaration 'XXX' for member 'XXX' ...'.