Skip to content

Commit

Permalink
Small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
alexprey committed Nov 19, 2018
1 parent 7b3d612 commit 0225d34
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how

## [1.1.0] Unreleased
- [Fix] Fix issue with component name parsing with default features set (Missing feature `name` in defaults features list)
- [Added] Implement parsing of js types for data properties from `@type` keyword or from default value
- [Added] Implement parsing of js types for data properties from `@type` keyword and from default value

## [1.0.0]
- Initial release
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ npm install --save sveltedoc-parser

- JSDoc support
- Support description extraction for everything items
- Support for visibility keywords: `@public`, `@protected`, `@private`
- Support visibility scope from JSDoc keywords: `@public`, `@protected`, `@private`
- Extract list of imported components
- Extract relative path to imported component (supports full-syntax and short-syntax import styles)
- Extract data properties
- Extract description from JSDoc comment
- Extract JS type from JSDoc (`@type {string}`) or parse default value
- Extract JS type from JSDoc (`@type {string}`) or parse default value if is not provided
- Extract computed properties with list of dependencies
- Extract list of references that attached to components or HTML elements
- Extract all fired events
Expand Down
2 changes: 1 addition & 1 deletion typings.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ declare interface JSDocType {
text: string,
/**
* The type representation of this item.
* @see `'type'` in `kind` field, then this field provide the name of JS type.
* @see `'type'|'const'` in `kind` field, then this field provide the name of JS type.
* @see `'union'` in `kind` field, then this field provide the list of @see JSDocType
*/
type: string|JSDocType[],
Expand Down

0 comments on commit 0225d34

Please sign in to comment.