Releases: peterpeterparker/tsdoc-markdown
Releases · peterpeterparker/tsdoc-markdown
v1.1.0
What's Changed
- fix: private method identifiers included in generated doc by @peterpeterparker in #46
- feat: support for class properties by @peterpeterparker in #47
- feat: generate properties empty array by @peterpeterparker in #48
- feat: context for inner function by @peterpeterparker in #49
Full Changelog: v1.0.0...v1.1.0
v1.0.0
What's Changed
- build: bump dev dependencies (including prettier) by @peterpeterparker in #38
- test: update mock by @peterpeterparker in #40
- build: bump eslint v9 by @peterpeterparker in #39
- build: bump Node LTS and actions by @peterpeterparker in #41
- feat: cmd option --noemoji by @peterpeterparker in #42
- build: tag v1.0.0 and adopt semver by @peterpeterparker in #43
Full Changelog: v0.6.3...v1.0.0
v0.6.3
Fix
- Option to render markdown without emoji was rendering few emojis.
v0.6.2
Fix
- Concatenate lines when types contain new lines.
Chore
- Revert unnecessary string cleanup.
v0.6.1
Fix
- JSDoc descriptions containing pipes were causing issues in Markdown tables.
v0.6.0
Features
- Generate jsDoc
@example
content (#28).
Shout-out to mingtianyihou33 for the contributions! 💪
v0.5.0
v0.4.0
Features
- Enable
strictNullChecks
per default when creating TypeScript compiler program. This allow exporting parameters and results that unionsnull
orundefined
.
For example:
/**
* Markdown should handle ` | ` for the type.
*/
export const genericType = <T>(value: [] | [T]): T | undefined => value?.[0];
Previously did not parsed the result | undefined
in the resulting documentation.
v0.3.0
Features
- Add support for jsDocs in Interfaces when generating markdown.
v0.2.1
Fix
- Remove backtick for the description of the Interfaces in generated markdown content.