yuidoc-asp

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>YUIDoc - JavaScript Documentation Tool</title> <link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Maven+Pro:400,700"> <link rel="stylesheet" href="http://yui.yahooapis.com/3.4.1/build/cssgrids/grids-min.css"> <link rel="stylesheet" href="assets/css/main.css"> <link rel="stylesheet" href="assets/vendor/prettify/prettify-min.css"> <link rel="icon" href="assets/favicon.ico"> <script src="http://yui.yahooapis.com/3.5.1/build/yui/yui.js"></script> </head> <body> <a href="https://github.com/yui/yuidoc"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> <div id="doc"> <div id="hd"> <h1><img src="http://yuilibrary.com/img/yui-logo-2x.png" width="117" height="52">YUIDoc - JavaScript Documentation Tool</h1> </div> <a href="#toc" class="jump">Jump to Table of Contents</a> <div class="yui3-g"> <div class="yui3-u-3-4"> <div id="main"> <div class="content"><h2 id="welcome-to-yuidoc-060">Welcome to YUIDoc 0.6.0!</h2> <div class="intro"> <p>YUIDoc is a <a href="http://nodejs.org/">Node.js</a> application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen. YUIDoc provides:</p> <ul> <li><b>Live previews.</b> YUIDoc includes a <a href="args/index.html#server">standalone doc server</a>, making it trivial to preview your docs as you write.</li> <li><b>Modern markup.</b> YUIDoc's generated documentation is an <a href="http://yuilibrary.com/yui/docs/api/classes/Model.html">attractive, functional web application</a> with real URLs and graceful fallbacks for spiders and other agents that can't run JavaScript.</li> <li><b>Wide language support.</b> YUIDoc was originally designed for the <a href="http://yuilibrary.com">YUI project</a>, but it is not tied to any particular library or programming language. You can use it with any language that supports <code>/* */</code> comment blocks.</li> </ul> </p> </div> <h2 id="#install">Installation and Usage</h2> <ol> <li>Download and install <a href="http://nodejs.org/#download">Node.js</a></li> <li>Run <code>npm -g install yuidocjs</code>.</li> <li>Run <code>yuidoc .</code> at the top of your JS source tree.</li> </ol> <p>That's it! For more information about running the <code>yuidoc</code> commandline tool, refer to "<a href="args/index.html">Using YUIDoc</a>".</p> <h2 id="user-guides">User Guides</h2> <ul> <li><a href="args/index.html">Using YUIDoc</a> — Understanding YUIDoc command line arguments and usage.</li> <li><a href="syntax/index.html">YUIDoc Syntax Reference</a> — Detailed instructions for writing YUIDoc comment blocks.</li> <li><a href="themes/index.html">YUIDoc Themes</a> — How to modify the default YUIDoc theme.</li> </ul> <h2 id="example-yuidoc-comment-blocks">Example YUIDoc Comment Blocks</h2> <p>YUIDoc parses a modified form of JSDoc tags. This section provides a taste of some of the more common constructs in YUIDoc. For more information, refer to the "<a href="./syntax/index.html">YUIDoc Syntax Reference</a>".</p> <h3 id="example-class-block">Example Class Block</h3> <pre class="code prettyprint">/** * This is the description for my class. * * @class MyClass * @constructor */</pre> <h3 id="example-method-block">Example Method Block</h3> <pre class="code prettyprint">/** * My method description. Like other pieces of your comment blocks, * this can span multiple lines. * * @method methodName * @param {String} foo Argument 1 * @param {Object} config A config object * @param {String} config.name The name on the config object * @param {Function} config.callback A callback function on the config object * @param {Boolean} [extra=false] Do extra, optional work * @return {Boolean} Returns true on success */</pre> <h3 id="example-property-block">Example Property Block</h3> <pre class="code prettyprint">/** * My property description. Like other pieces of your comment blocks, * this can span multiple lines. * * @property propertyName * @type {Object} * @default "foo" */</pre> </div> </div> </div> <div class="yui3-u-1-4"> <div class="sidebar"> <ul class="links"> <li><a href="https://github.com/yui/yuidoc/" class="button">Get the Source</a></li> <li><a href="https://groups.google.com/forum/#!forum/yuidoc" class="button">Questions? Join the Mailing List</a></li> <li><a href="https://github.com/yui/yuidoc/issues/" class="button">File an Issue</a></li> <li><a href="api/" class="button">View API Documentation</a></li> </ul> <div class="sidebox"> <div class="hd"> <h2 class="no-toc">Build Status</h2> </div> <div class="bd"> <a href="http://travis-ci.org/yui/yuidoc"><img src="https://secure.travis-ci.org/yui/yuidoc.png?branch=master" border="0"></a> </div> </div> <div id="toc" class="sidebox"> <div class="hd"> <h2 class="no-toc">Table of Contents</h2> </div> <div class="bd"> <ul class="toc"> <li> <a href="#welcome-to-yuidoc-060">Welcome to YUIDoc 0.6.0!</a> </li> <li> <a href="##install">Installation and Usage</a> </li> <li> <a href="#user-guides">User Guides</a> </li> <li> <a href="#example-yuidoc-comment-blocks">Example YUIDoc Comment Blocks</a> <ul class="toc"> <li> <a href="#example-class-block">Example Class Block</a> </li> <li> <a href="#example-method-block">Example Method Block</a> </li> <li> <a href="#example-property-block">Example Property Block</a> </li> </ul> </li> </ul> </div> </div> </div> </div> </div> </div> <script src="assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> </body> </html>