Releases: peterpeterparker/tsdoc-markdown
Releases · peterpeterparker/tsdoc-markdown
v1.4.1
What's Changed
- feat: render metadata after properties for consistency by @peterpeterparker in #73
Full Changelog: v1.4.0...v1.4.1
v1.4.0
Summary
This version supports @see and @link tags to render a list of references.
For example, it can render:
References:
- hello2
- https://daviddalbusco.com
hello- Source code
What's Changed
- build: bump dev dependencies by @peterpeterparker in #66
- chore: allow underscore _ for lint by @peterpeterparker in #67
- feat: support for
@seeto render list of references by @peterpeterparker in #65 - fix: missing jsDocs in classes by @peterpeterparker in #69
- refactor: extract markdown types and jsdocs to separate modules by @peterpeterparker in #70
- refactor: extract render jsdocs metadata and url by @peterpeterparker in #71
- refactor: extract jsDocs metadata render helper by @peterpeterparker in #72
- feat: render jsDocs and source url for classes and interfaces by @peterpeterparker in #68
Full Changelog: v1.3.0...v1.4.0
v1.3.0
What's Changed
- chore: fix ubuntu runner by @peterpeterparker in #58
- Added @returns to the documentation by @edewit in #61
- chore: run formatter after returns support addition by @peterpeterparker in #62
- refactor: extract duplicated reducer by @peterpeterparker in #63
- feat: markdown formatting (spacing) for @returns support by @peterpeterparker in #64
New Contributors
Full Changelog: v1.2.0...v1.3.0
v1.2.0
What's Changed
- chore: migrate to eslint v9 by @peterpeterparker in #53
- feat: correct few eslint warnings and disable some rules (for now) by @peterpeterparker in #55
- chore: setup ci checks by @peterpeterparker in #54
- feat: support for static methods and properties by @peterpeterparker in #56
- build: bump dev dependencies by @peterpeterparker in #57
Full Changelog: v1.1.1...v1.2.0
v1.1.1
What's Changed
- fix: support for const that contains arrow functions by @peterpeterparker in #50
Full Changelog: v1.1.0...v1.1.1
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.