This version is not covered by your current version range.
If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.
This plugin no longer attempts to work around the two comment problem in order to identify a comment as module documentation. I recommend using the @packageDocumentation annotation going forward. The issue comment states that TypeDoc will continue to support the two comment legacy mechanism.
Before:
/** @module foo */
After:
/** @packageDocumentation @module foo */
or
/** @packageDocumentation @module foo */ /** for typedoc */
FAQ and help
There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).
The devDependency typedoc-plugin-external-module-name was updated from
2.2.1
to3.0.0
.This version is not covered by your current version range.
If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.
Publisher: christopherthielen License: MIT
Release Notes for 3.0.0
3.0.0 (2020-01-16)
Compare
typedoc-plugin-external-module-name
versions 2.2.1 and 3.0.0Bug Fixes
Features
BREAKING CHANGE
This plugin no longer attempts to work around the two comment problem in order to identify a comment as module documentation. I recommend using the
@packageDocumentation
annotation going forward. The issue comment states that TypeDoc will continue to support the two comment legacy mechanism.Before:
After:
or
Commits
The new version differs by 9 commits.
eb9951b
3.0.0
e36ae2a
chore: Add a barebones DEVELOPING.md with instructions for running the integration tests
f2dad45
test: Use a github actions matrix to test typedoc versions
8e36d35
test: add tests for typedoc 0.16.5
02aa15a
feat(typedoc0.16.4): Support typedoc 0.16.4
2be99b7
test: Add some tests, update some tests
c8a04d4
test: Add some tests, update some tests
0089d19
fix(typedoc0.16): Some fixes for 0.16.x (WIP)
bd9b5cd
fix(emptycomment): Remove empty comments on source reflections that are being merged, just in case.. not sure if this is even necessary!
See the full diff
FAQ and help
There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).Your Greenkeeper bot :palm_tree: