在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):jsBoot/gulp-yuidoc开源软件地址(OpenSource Url):https://github.com/jsBoot/gulp-yuidoc开源编程语言(OpenSource Language):JavaScript 100.0%开源软件介绍(OpenSource Introduction):gulp-yuidocWARNINGThis is an early release, and you will likely encounter bugs or limitations. TL;DRInstall npm install --save-dev gulp-yuidoc Then, add it to your var yuidoc = require("gulp-yuidoc");
gulp.src("./src/*.js")
.pipe(yuidoc())
.pipe(gulp.dest("./doc")); APIyuidoc.parser(options, name)Calling the parser alone will build a vinyl containing the parsing result of fed files. By default, that vinyl will get named "yuidoc.json", unless you override it with the optional "name" argument. "options" allows you to speficy yuidoc parsing options (XXX untested). gulp.src("./src/*.js")
.pipe(yuidoc.parser())
.pipe(gulp.dest("./jsondocoutput")); yuidoc.reporter()Reports whatever went wrong with parsing. gulp.src("./src/*.js")
.pipe(yuidoc.parser())
.pipe(yuidoc.reporter()) If you prefer ugly things, call yuidoc.generator(options)Generates documentation from the result of the parser. gulp.src("./src/*.js")
.pipe(yuidoc.parser())
.pipe(yuidoc.generator())
.pipe(gulp.dest('./documentation-output')) You may pass yuidoc generator options optionally (XXX untested - undocumented). yuidoc(parseOpts, renderOpts)This: gulp.src("./src/*.js")
.pipe(yuidoc())
.pipe(gulp.dest('./documentation-output')) is a shortcut for: gulp.src("./src/*.js")
.pipe(yuidoc.parser())
.pipe(yuidoc.reporter())
.pipe(yuidoc.generator())
.pipe(gulp.dest('./documentation-output')) ConfigurationTo add project-level configuration, such as version and project name, add them to a
.pipe(yuidoc({
project: {
"name": "The Foo API",
"description": "The Foo API: a library for doing X, Y, and Z",
"version": "1.2.0",
"url": "http://example.com/"
}
})) License |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论