YUIDoc

YUI Javascript文档工具。(YUI Javascript Documentation Tool. )

Github stars Tracking Chart

YUIDoc是在构建时使用的Node.js应用程序,用于生成JavaScript代码的API文档。 YUIDoc是注释驱动的,并支持各种JavaScript编码风格。 YUIDoc的输出是API文档格式化为一组HTML页面,包括有关JavaScript对象的方法,属性,自定义事件和继承的信息。

YUIDoc最初是为YUI项目编写的; 它在生成的文件中使用YUI JavaScript和CSS,并且它支持常见的YUI约定,如自定义事件。 也就是说,它可以在非YUI代码上轻松有效地使用。

Overview

Name With Owneryui/yuidoc
Primary LanguageHTML
Program languageMakefile (Language Count: 6)
Platform
License:Other
Release Count66
Last Release Namev0.10.2 (Posted on )
First Release Nameyuidoc-2 (Posted on 2008-12-01 16:18:55)
Created At2008-12-05 02:26:02
Pushed At2019-11-06 20:37:31
Last Commit At2017-04-17 21:29:43
Stargazers Count892
Watchers Count42
Fork Count211
Commits Count1.1k
Has Issues Enabled
Issues Count295
Issue Open Count122
Pull Requests Count119
Pull Requests Open Count9
Pull Requests Close Count28
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private

YUIDoc

YUI's JavaScript Documentation engine.

npm Version
Build Status
Dependency Status

Overview

YUIDoc is a Node.js application used at build time to
generate API documentation for JavaScript code. YUIDoc is comment-driven and supports a wide
range of JavaScript coding styles. The output of YUIDoc is API documentation formatted as a
set of HTML pages including information about methods, properties, custom events and
inheritance for JavaScript objects.

YUIDoc was originally written for the YUI Project; it uses YUI JavaScript and CSS in the
generated files and it supports common YUI conventions like Custom Events. That said,
it can be used easily and productively on non-YUI code.

Installation

npm install -g yuidocjs

Documentation

Contributing

Please see the CONTRIBUTING.md.

License

This software is free to use under the Yahoo Inc. BSD license. See the LICENSE file for license text and copyright information.

To the top