YUILibrary - Open source JavaScript and CSS for building richly interactive software.
Fork YUI on GitHub

YUI 2.x

YUI Doc

YUI Doc is a tool written in Python that generates beautiful, organized, searchable API documentation for your JavaScript code. You will typically use YUI Doc as part of your build process. YUI Doc is comment-driven and is compatible with a variety of coding styles. You do not need to be using YUI Library JavaScript in order to use YUI Doc.

Reporting Defects / Making Enhancement Requests

YUILibrary.com is the proper location for reporting defects found in the YUI Doc code as well as for logging enhancement requests for consideration for future updates. You can review existing tickets filed for YUI Doc by clicking the View Tickets link at the top of this page. Please review the YUI guidelines for filing defects and making enhancement requests before adding new tickets to the YUI Doc project using the New Ticket link above.

*Only logged in users can submit bugs and feature requests.

Latest Commits for YUI Doc

SHA1 Developer Date Message
1c76ee672 Dav Glass 03/1/10 Fixed JS Syntax error
b39ba67c2 Adam Moore 01/13/10 fixed typo
cf62eebf2 Adam Moore 01/6/10 2009 -> 2010
99e77a8d5 Adam Moore 12/16/09 .
018bced79 Adam Moore 12/16/09 Fixed compatibility with old templates
55e8aac5e Adam Moore 12/16/09 Checked in transitional script file that maps to the current state of the template.
f645772a0 Adam Moore 12/7/09 Fixed incorrect index for inherited configuration attributes [fixes #2173343].
599ce45d6 Satyen Desai 11/30/09 Added whitespace to test builds from yuisource
952dc8611 Adam Moore 11/18/09 The file list for each parsed directory is sorted prior to processing to prevent parse order differences when parsing the same files in different environments.
9e4e1282f Adam Moore 10/27/09 Added note about easy_install failing when pulling a non-stable version of Cheetah.
005f99924 Adam Moore 09/24/09 @return description with no type is no longer omitted from the generated docs.
807cccab0 Adam Moore 08/10/09 More tolerant of parse order issues. duplicate module declarations do not result in duplicate submodule/class entries.
f95e78e3a Adam Moore 07/6/09 left nav module links corrected to used the cleansed module name [fixes #2173322].
c4382388a Adam Moore 07/3/09 Completely refactored all io operations to eliminate anything encoding unicode to utf-8. Fixes unicode battles with the latest versions of Cheetah.
2affa9a64 Adam Moore 07/2/09 Added known issues and workarounds. Identified international character encoding issues with later versions of Cheetah; updated installation instructions with advice for the version of Cheetah to install.
8a1b2a363 Adam Moore 06/30/09 file marker assumption is that there is one module per specified subtree. Files don't get mapped properly when multiple modules are contained in a single specified subtree. changed lang test so that it specifies each sub-project as a separate input.
d23d4ce83 Adam Moore 06/30/09 moved newline hack into file marker, added multi-lang test
e56f4efd9 Dav Glass 06/25/09 Added support for C#
b0fc89982 Adam Moore 06/24/09 CSS fix for IE6/7 that was preventing the show private/etc checkboxes from working. Updated YUI js to 2.7.0.
7ad3bace8 Dav Glass 06/24/09 Addes support for Java
8829c572f Adam Moore 06/24/09 Fixed utf related highlighter crash [fixes #22]
0a5fd4774 Adam Moore 06/24/09 Removed all submodule links until we have this is organized better.
2a8871171 Dav Glass 06/24/09 Added support for Python, Perl and Ruby
babd41bb1 Adam Moore 06/22/09 readonly is valid without a description
106e19aad Dav Glass 06/22/09 Fixed issue with older version of python
The YUI Team is hiring.

Product Information

Current Version: 1.0.0b1
Release Date: 12/05/2008

Developer Information

Development Version: NEXT
Tentative Release Date: Not Planned

Recent Forum Posts