diff --git a/CHANGELOG.md b/CHANGELOG.md index bd4f372..9f5a413 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 \ No newline at end of file diff --git a/README.md b/README.md index db9f5ad..3efaa19 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/typings.d.ts b/typings.d.ts index 253b033..fab3c50 100644 --- a/typings.d.ts +++ b/typings.d.ts @@ -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[],