Releases: TypeStrong/typedoc
Releases Β· TypeStrong/typedoc
v0.16.6
v0.16.5
Fixed π
@BindOption
now works with plugin options (#1174)- Empty modules are no longer included in the HTML documentation (#1126)
Changed π¦
- The project version is no longer added to the package name by default, specify the
--includeVersion
flag to include it. (#1175) - The
NavigationBuilder
class is now available to simplify theme creation (#1171)
Thanks π
v0.16.4
v0.16.3
Fixed π
@hidden
can now be used to selectively hide overloads (#1142)- Plugins are now correctly autoloaded (#1170)
- Corrected JSON output types
Changed π¦
@Option
decorator deprecated in favor of registering manually.@BindOption
property decorator now available for fetching options like@Option
- References are now no longer created for source files not included in the documentation
Thanks π
Thank you to all who reported issues and the following code contributors:
v0.16.2
Features β¨
- Plugins may now use the
@Option
decorator to declare options. (#1165)
Fixed π
@param
and@returns
are overly sensitive to whitespace (#1164)- TypeDoc is missing exported values to set options without importing internals (#1163)
Changed π¦
- TypeDoc's tests now run in ~30 seconds instead of 3 minutes, making for a much better development experience (#1156)
v0.16.0 / v0.16.1
Features β¨
- In modules mode, export declarations are now resolved.
- Support for
import x =
Fixed π
expandInputFiles
will no longer throw if the input directory includes a symbolic link (#751)- Nested object literals are now correctly marked as exported (#1103)
- Resolve and link
TypeOperatorType
types (#1161)
Breaking Changes β οΈ
- With
--mode file
, all declarations are now considered exported. - When using the programmatic API, if you want to automatically read
tsconfig.json
andtypedoc.json
you must add the readers to theOptions
class onApplication
typedoc.js
may no longer return a function to be called to set options.Options
now calls the registered option readers instead of firing an event.- Programmatic users must call
app.bootstrap
with their options instead ofnew App(options)
Thanks! π
TypeDoc would be far worse off without these people's help.
v0.15.8
v0.15.7
v0.15.6
Fixed π
- When using recursive types TypeDoc ran out of memory (#1150)
- Improved performance by ~20% when
--ignoreCompilerErrors
is passed by not asking TypeScript for the errors (#1032) - Fixes included in [email protected]
Features β¨
- Support for TS2.8 conditional types (#831)
- Support for indexed-access types (#1153)
- The
@packageDocumentation
tag can now be used to mark a comment as a file comment. Docs (#603, #1080)
Changes π¦
- TypeDoc now includes the package version in the documentation (#544)