This repository was archived by the owner on Mar 8, 2019. It is now read-only.
File tree 5 files changed +3
-157
lines changed
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);
29
29
| filePath | string | The file path |
30
30
31
31
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
-
43
32
## Using JSDoc tags
44
33
45
34
You can use the following [ JSDoc] [ ] tags when documenting components, props and methods.
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " vue-docgen-api" ,
3
- "version" : " 2.0.11 " ,
3
+ "version" : " 2.0.12 " ,
4
4
"description" : " Toolbox to extract information from Vue component files for documentation generation purposes." ,
5
5
"bugs" : {
6
6
"url" : " https://github.com/vue-styleguidist/vue-docgen-api/issues"
41
41
"jsdoc-api" : " ^3.0.0" ,
42
42
"lru-cache" : " ^4.1.0" ,
43
43
"vue-template-compiler" : " ^2.4.2" ,
44
- "vue-webpack-loaders" : " ^1.0.5 "
44
+ "vue-webpack-loaders" : " ^1.0.6 "
45
45
},
46
46
"devDependencies" : {
47
47
"babel-eslint" : " ^7.2.3" ,
Original file line number Diff line number Diff line change 1
1
import * as utils from './utils' ;
2
2
import parse from './parse' ;
3
- import parseWebpack from './parseWebpack' ;
4
3
5
- function defaultParse ( src , webpackConfig ) {
4
+ function defaultParse ( src ) {
6
5
return parse ( src ) ;
7
6
}
8
7
9
- function defaultParseWebpack ( src ) {
10
- return parseWebpack ( src ) ;
11
- }
12
-
13
8
export {
14
9
defaultParse as parse ,
15
- defaultParseWebpack as parseWebpack ,
16
10
utils ,
17
11
} ;
18
12
Load Diff This file was deleted.
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments