YUIDoc

  518 downloads
0.7.0 BSD License
5.0/5 2
A documentation generator written in JavaScript to run on Node.js, a tool that scans source code comments and outputs HTML-based documentation sites

description

download

specifications

changelog

YUIDoc is the official documentation generator used by the Yahoo! team for the Yahoo! User Interface 3.x (YUI) series.

The app works by scanning JavaScript code for comments, and using them as documentation for the code itself.

YUIDoc can be used to document information about properties, custom events, methods and inheritance for JS objects.

Besides generating documentation sites out of JavaScript code, YUIDoc also comes with a built-in Web server as well. This feature was included to allow developers to preview documentation sites in real-time, while they write their code and comments.

YUIDoc should not be confused with YUI Doc, a similar documentation generator from Yahoo, but written mainly in Python.
READ MORE   
Last updated on April 30th, 2015
1  
YUIDoc - A sample YUIDoc page provides quick access to various sections of the documentation

0 User reviews so far.

SUBMIT