dgeni-packages - npm Package Versions

0.21.5 8 October 2017

Fixes

• typescript: handle property accessors correctly 75fafcf7

0.21.4 28 September 2017

Features

• typescript:
  • add isReadonly flag to member docs 62bc5333
  • include typeParameters in type-alias docs 51d81496

Fixes

• typescript: show both type and initializer on parameters d677e72a

0.21.3 22 September 2017

Features

• typescript: track descendants of inherited classes b64e8519

0.21.2 11 September 2017

Fixes

• typescript: do not render comments in decorator arguments 7cfd8021

Chores

• upgrade to TypeScript 2.4 1d64fcc7

0.21.1 4 September 2017

Features

• typescript: support overloaded constructors ca69213d

Bug Fixes

• typescript: fix possibly null references 463ef5cf

0.21.0 4 September 2017

Features

• typescript: reference extands and implements ancestor info d7c29603

## BREAKING CHANGES:

Previously, the doc.implementsClauses and doc.extendsClauses were arrays of strings, describing the text of the clause.

Now, these properties are of type HeritageInfo:

class HeritageInfo {
  symbol: Symbol | undefined;
  doc: ClassLikeExportDoc | undefined;
  type: ExpressionWithTypeArguments;
  text: string;
}

where the text property holds the value that was previously provided.

You need to change your code/templates to access the text of the heritage clause from:

{% for clause in doc.extendsClauses %}{$ clause $}{% endfor %}

to:

{% for clause in doc.extendsClauses %}{$ clause.text $}{% endfor %}

0.20.1 16 August 2017

Features

• jsdoc: add propertyof jsdoc tag 6712e544

Fixes

• dgeni: ensure that dgeni self documenting config works 8052e9e6

0.20.0 27 July 2017

This is the full release of 0.20.0 - the list of changes below includes all the beta and release candidate changes.

Features

• base: allow checkAnchorLinks to abort processing eee3e7b1
• typescript:
  • group function/method overloads together 2155b5ac
  • provide isCallMember and isNewMember options
  • split out heritage into extendsClauses and implementsClauses
  • add realFilePath/realProjectRelativePath to FileInfo c7d1b54c

Performance Improvements

• nunjucks: upgrade to v3 and enable caching of templates

Bug Fixes

• ngdoc: pass doc object to createDocMessage fe98a849 Nick Horvath
• typescript:
  • add type parameters to function export docs c2c29270
  • remove duplicate overload from abstract API doc members f2c481d1
  • support startingLine and endingLine properties 32698f30
  • include specified namespaces in types dbe99f7b
  • allow decorators to not be call expressions e41a392a
  • implement the CompilerHost.readFile method 4d667ff2
  • CustomCompilerHost.fileExists should not second guess extensions and base dir b7b11164
  • compile files in folders that have file-like names ee10b835
  • paths should be case sensitive 5238302b
  • compile files in folders that have file-like names
  • paths to imports are case sensitive
  • group overloaded exported functions in a single doc
  • do not assume that members prefixed with _ are private
• base: checkAnchorLinks should match URL encoded chars

Breaking Changes

Previously to 0.20.0 the service where you registered namespaces not to strip was called ignoreTypeScriptNamespaces and took an array of regular expressions.

Now this service is called namespacesToInclude, which better reflects its purpose. Also it is now an array of strings, since there was little benefit in it being a regular expression.

<hr>

The typescript package has been completely rewritten in TypeScript. One benefit of this is that typings should be available for the API doc types in your own projects.

Along the way there are some changes to the properties that are attached to the API docs that are generated. Here is a list of the things that might affect you:

• Members starting with _ are no longer considered private. You should filter them out in a custom processor if you do not want them to appear in the docs.
• API docs that have a type, e.g. functions, constants, type aliases, etc used to have a property called returnType but that did not make sense for non-functions. This property is renamed to type.
• API docs that have heritage, e.g. classes and interfaces, used to have a property called heritage, which was a string representation containing both "implements" and "extends" clauses. These have now been split into two properties implementsClauses and extendsClauses, which each contain an array of strings.

0.20.0-rc.6 14 July 2017

Bug Fixes

typescript: add type parameters to function export docs c2c29270

0.20.0-rc.5 13 July 2017

Bug Fixes

typescript: remove duplicate overload from abstract API doc members f2c481d1 ngdoc: pass doc object to createDocMessage fe98a849 Nick Horvath