|
1 | 1 | # Unreleased |
2 | 2 |
|
| 3 | +### Breaking Changes |
| 4 | + |
| 5 | +- Node 12 is no longer officially supported as it has gone end of life as of 2022-04-30. It might still work, but may stop working at any time. |
| 6 | +- Dropped support for TypeScript before 4.6. |
| 7 | +- `{@link}` tags in comments will now be resolved as declaration references similar to TSDoc's declaration references. |
| 8 | + For most cases, this will just work. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on how link resolution works. |
| 9 | +- TypeDoc will now produce warnings for bracketed links (`[[ target ]]`). Use `{@link target}` instead. The `{@link}` syntax will be recognized by [TypeScript 4.3](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-3.html#editor-support-for-link-tags) and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for `[[ target ]]` style links. |
| 10 | +- `extends` in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with `./`. |
| 11 | +- In the JSON output for `DeclarationReflection`s, `getSignature` is no longer a one-tuple. |
| 12 | +- In the JSON output for `DeclarationReflection`s, `setSignature` is no longer a one-tuple. |
| 13 | +- In the JSON output for `DeclarationReflection`s, `typeParameter` has been renamed to `typeParameters` |
| 14 | +- The `searchGroupBoosts` option must now be given the rendered group name rather than reflection kind names, and can be given custom group names. |
| 15 | +- `@inheritDoc` now follows the behavior specified by TSDoc when copying comments with a reference. |
| 16 | +- The `gaSite` option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846. |
| 17 | +- Comments on export declarations will only overrides comments for references and namespaces, #1901. |
| 18 | +- The deprecated `listInvalidSymbolLinks` option has been removed. Use `validation.invalidLink` instead. |
| 19 | +- The deprecated `true` and `false` values have been removed from `--emit`, to migrate replace `true` with `"both"` and `false` with `"docs"` (the default). |
| 20 | +- Links are no longer be resolved against a global list of all symbols. See [the documentation](https://typedoc.org/guides/link-resolution/) for details on link resolution. |
| 21 | +- The `validation.invalidLink` option is now on by default. |
| 22 | +- `reflection.decorates`, `reflection.decorators`, and their corresponding interfaces have been removed as no code in TypeDoc used them. |
| 23 | +- The shape of the `Comment` class has changed significantly to support multiple tag kinds. |
| 24 | +- Listeners to `Converter.EVENT_CREATE_TYPE_PARAMETER` and `Converter.EVENT_CREATE_DECLARATION` will now never be passed a `ts.Node` as their third argument. |
| 25 | +- Constant variables which are interpreted as functions will no longer have the `ReflectionFlag.Const` flag set. |
| 26 | +- `reflection.defaultValue` is no longer set for enum members. The same information is available on `reflection.type` with more precision. |
| 27 | +- Removed deprecated `removeReaderByName`, `addDeclarations` and `removeDeclarationByName` methods on `Options`. |
| 28 | +- Removed `ProjectReflection.directory`, it was unused by TypeDoc and not properly tested. |
| 29 | +- Removed `ProjectReflection.files`, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster. |
| 30 | +- Removed `ReflectionGroup.kind` since groups can now be created with the `@group` tag. |
| 31 | +- Removed `ReflectionKind.Event`, the `@event` tag is now an alias for `@group Events`. Note: This changes the value of `ReflectionKind.Reference` from `16777216` to `8388608`. |
| 32 | +- Themes are now set on the document element rather than on body, #1706. |
| 33 | + |
| 34 | +### Features |
| 35 | + |
| 36 | +- TypeDoc now supports the `@group` tag to group reflections in a page. If no `@group` tag is specified, reflections will be grouped according to their kind, #1652. |
| 37 | +- TypeDoc will now search for `typedoc.js(on)` in the `.config` folder in the current working directory. |
| 38 | +- Entry point strategies `Resolve` and `Expand` may now specify globs, #1926. |
| 39 | +- `typedoc.json` now supports comments like `tsconfig.json`. |
| 40 | +- TypeDoc will now read the `blockTags`, `inlineTags`, and `modifierTags` out of `tsdoc.json` in the same directory as `tsconfig.json` if it exists. |
| 41 | + It is recommended to add `"extends": ["typedoc/tsdoc.json"]`, which defines TypeDoc specific tags to your `tsdoc.json` if you create one. |
| 42 | +- If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855. |
| 43 | +- Improved support for JSDoc style `@example` tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135. |
| 44 | +- TypeDoc will now render members marked with `@deprecated` with a line through their name, #1381. |
| 45 | +- Added new `commentStyle` option which can be used to control what comments TypeDoc will parse. |
| 46 | + |
| 47 | + | Value | Behavior | |
| 48 | + | ----- | -------------------------------------- | |
| 49 | + | JSDoc | Use block comments starting with `/**` | |
| 50 | + | Block | Use all block comments | |
| 51 | + | Line | Use `//` comments | |
| 52 | + | All | Use both block and line comments | |
| 53 | + |
| 54 | +- TypeDoc will now warn if part of a comment will be overwritten due to use of `@inheritDoc` instead of silently dropping part of the comment. |
| 55 | +- Added support for inline `@inheritDoc` tags, #1480. |
| 56 | +- It is now possible to link directly to a specific overload, #1326. |
| 57 | +- The JSON output will now include URLs to the file on the remote repository if possible. |
| 58 | +- Added a new `visibilityFilters` option which controls the available filters on a page. |
| 59 | +- TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, #1923. |
| 60 | +- Added `blockTags`, `inlineTags`, `modifierTags` to control which tags TypeDoc will allow when parsing comments. |
| 61 | + If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag. |
| 62 | + |
| 63 | +### Bug Fixes |
| 64 | + |
| 65 | +- Fixed off by one error in warnings for types referenced but not included in the documentation. |
| 66 | +- TypeDoc will no longer render a `Type Parameters` heading if there are no type parameters in some cases. |
| 67 | +- Improved source location detection for constructors. |
| 68 | +- Improved comment discovery on destructured exported functions, #1770. |
| 69 | +- Links which refer to members within a reference reflection will now correctly resolve to the referenced reflection's member, #1770. |
| 70 | +- Correctly detect optional parameters in JavaScript projects using JSDoc, #1804. |
| 71 | +- Fixed identical anchor links for reflections with the same name, #1845. |
| 72 | +- TypeDoc will now automatically inherit documentation from classes `implements` by other interfaces/classes. |
| 73 | +- Fixed `@inheritDoc` on accessors, #1927. |
| 74 | +- JS exports defined as `exports.foo = ...` will now be converted as variables rather than properties. |
| 75 | +- `searchCategoryBoosts` are now correctly computed for all categories, #1960. |
| 76 | +- The `excludeNotDocumented` option will no longer hide a module if it has a documentation comment, #1948. |
| 77 | +- Prevent `--excludeNotDocumented` from hiding properties of type literals (`a` in `function fn(p: { a: string })`), #1752. |
| 78 | +- Allow `cts` and `mts` extensions in packages resolution mode, #1952. |
| 79 | +- Corrected schema generation for https://typedoc.org/schema.json |
| 80 | + |
| 81 | +### Thanks! |
| 82 | + |
| 83 | +- @aqumus |
| 84 | +- @fb55 |
| 85 | +- @futurGH |
| 86 | +- @Shane4368 |
| 87 | +- @shmax |
| 88 | + |
3 | 89 | ## v0.22.18 (2022-06-25) |
4 | 90 |
|
5 | 91 | ### Features |
|
864 | 950 | - Missing comments on variable functions, closes #1421 |
865 | 951 | - Resolve type parameters in concrete subclasses |
866 | 952 | - Use entryPoints to search for readme |
867 | | -- Only create extra programs when dealing with solution style tsconfigs |
| 953 | +- Only create extra programs when dealing with solution style tsconfig.json files |
868 | 954 | - A typo in description of DefaultTheme.getMapping (#1416) |
869 | 955 | - Correct handling of arrays in generic constraints, closes #1408 |
870 | 956 | - Type converters threw on older TS versions |
|
0 commit comments