This repository was archived by the owner on Mar 8, 2019. It is now read-only.
File tree Expand file tree Collapse file tree 5 files changed +3
-157
lines changed Expand file tree Collapse file tree 5 files changed +3
-157
lines changed Original file line number Diff line number Diff line change @@ -29,17 +29,6 @@ var componentInfo = vueDocs.parse(filePath);
2929| filePath | string | The file path |
3030
3131
32- ### parseWebpack(filePath \[ , webpackConfig \] )
33-
34- Has implemented [ enhanced-require] ( https://github.com/webpack/enhanced-require )
35-
36- | Parameter | Type | Description |
37- | -------------- | ------ | --------------- |
38- | filePath | string | The file path |
39- | webpackConfig | object | Optional argument, extracts the necessary loaders to document the component. |
40-
41-
42-
4332## Using JSDoc tags
4433
4534You can use the following [ JSDoc] [ ] tags when documenting components, props and methods.
Original file line number Diff line number Diff line change 11{
22 "name" : " vue-docgen-api" ,
3- "version" : " 2.0.11 " ,
3+ "version" : " 2.0.12 " ,
44 "description" : " Toolbox to extract information from Vue component files for documentation generation purposes." ,
55 "bugs" : {
66 "url" : " https://github.com/vue-styleguidist/vue-docgen-api/issues"
4141 "jsdoc-api" : " ^3.0.0" ,
4242 "lru-cache" : " ^4.1.0" ,
4343 "vue-template-compiler" : " ^2.4.2" ,
44- "vue-webpack-loaders" : " ^1.0.5 "
44+ "vue-webpack-loaders" : " ^1.0.6 "
4545 },
4646 "devDependencies" : {
4747 "babel-eslint" : " ^7.2.3" ,
Original file line number Diff line number Diff line change 11import * as utils from './utils' ;
22import parse from './parse' ;
3- import parseWebpack from './parseWebpack' ;
43
5- function defaultParse ( src , webpackConfig ) {
4+ function defaultParse ( src ) {
65 return parse ( src ) ;
76}
87
9- function defaultParseWebpack ( src ) {
10- return parseWebpack ( src ) ;
11- }
12-
138export {
149 defaultParse as parse ,
15- defaultParseWebpack as parseWebpack ,
1610 utils ,
1711} ;
1812
Load Diff This file was deleted.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments