Skip to content

Commit 480ae2e

Browse files
author
Maximilian Wehrstedt
committed
Prepared release v2.0.0
1 parent 12f4d6f commit 480ae2e

File tree

3 files changed

+44
-1
lines changed

3 files changed

+44
-1
lines changed

CHANGELOG.md

+36
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,41 @@
11
## Changelog
22

3+
# v2.0.0
4+
Bugfixes
5+
- Inline annotations will now be ignored by default. E. g. for this annotation
6+
```js
7+
/** @type {string} */
8+
var fuu = "bar";
9+
```
10+
were created a member in the corresponding namespace
11+
- Fixed errors in log messages
12+
- Module types were not parsed correctly ( [#39](https://github.com/otris/jsdoc-tsd/issues/39) and [#52](https://github.com/otris/jsdoc-tsd/issues/52))
13+
- Support for `@extends`
14+
- Fixes for resolving memberships in classes
15+
- Property params of type arrays caused an exception while generating the definition file
16+
```js
17+
/**
18+
* @param {object[]} fuu
19+
* @param {string} fuu[].bar <= Caused exception
20+
*/
21+
```
22+
- In some cases, type `null` caused exceptions
23+
24+
New features in this release:
25+
- Type definitions != object will be transformed to type declarations, e. g.
26+
```js
27+
/** @typedef {string|number} NumberLike */
28+
```
29+
will be transformed to
30+
```ts
31+
declare type NumberLike: string|number;
32+
```
33+
- Support for annotation `@this` ([#54](https://github.com/otris/jsdoc-tsd/issues/54))
34+
- Support for annotation `@hideconstructor` ([#53](https://github.com/otris/jsdoc-tsd/issues/53))
35+
- Support for annotation `@extends` ([#56](https://github.com/otris/jsdoc-tsd/issues/56))
36+
- Undocumented members will be skipped by default (can be configured)
37+
- Possibility to disable the since-tag check
38+
339
# v1.0.4
440
Bugfixes
541
- We updated [dts-dom](https://github.com/RyanCavanaugh/dts-dom) to fix [#49](https://github.com/otris/jsdoc-tsd/issues/49)

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ module.exports = function(taggedVersion, latestVersion) {
5959
// do what you need to
6060
}
6161
```
62+
* **ignoreSinceTag [=false]** Indicates wether to skip since tag check or not
63+
* **logItemsSkippedBySince [=true]** Logs every item which is ignored by the since tag
64+
* **skipUndocumented [=true]** Ignores undocumented items
65+
6266
## Supported Tags
6367
* @enum
6468
* @function (implicitly)
@@ -76,6 +80,9 @@ module.exports = function(taggedVersion, latestVersion) {
7680
* @module (function and variable declarations)
7781
* @private (not completed yet)
7882
* @const / @constant
83+
* @this
84+
* @hideconstructor
85+
* @extends
7986

8087
## Supported typscript tags
8188
* @template Note: You can write here any value you want, there will be no validation

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@otris/jsdoc-tsd",
3-
"version": "1.0.5-beta.0",
3+
"version": "2.0.0",
44
"description": "JSDoc Template for generate typescript definition files from JSDoc comments",
55
"main": "src-out/core/publish.js",
66
"repository": {

0 commit comments

Comments
 (0)