--- /dev/null
+<!DOCTYPE html>\r
+<html>\r
+ <head>\r
+ <meta charset="utf-8">\r
+ <title>NitDoc | Help</title>\r
+ \r
+ <script type="text/javascript" src="scripts/jquery-1.7.1.min.js"></script>\r
+ <script type="text/javascript" src="scripts/js-facilities.js"></script>\r
+ \r
+ <link rel="shortcut icon" href="favicon.ico">\r
+ <link rel="stylesheet" href="./styles/main.css" type="text/css" media="screen">\r
+ </head>\r
+ <body>\r
+ <!-- Page header -->\r
+ <header>\r
+ <!-- Main navigation -->\r
+ <nav class="main">\r
+ <ul>\r
+ <li><a href="index.html">Overview</a></li>\r
+ <li><a href="module.html">Module</a></li>\r
+ <li><a href="class.html">Class</a></li>\r
+ <li><a href="full-index.html">Index</a></li>\r
+ <li class="current">Help</li>\r
+ </ul>\r
+ </nav>\r
+ </header>\r
+ \r
+ <!-- Page content -->\r
+ <div class="page">\r
+ <!-- Content -->\r
+ <div class="content fullpage">\r
+ <h1>Help</h1>\r
+ <div class="subtitle">This documentation is organized as follows.</div>
+
+ <article>\r
+ <h2>Menu Bar</h2>\r
+ <p>The menu bar allows you to navigate different views of this documentation.</p>
+ <ul>
+ <li>The <a href="index.html">Overview</a> is the front page of this documentation</li>
+ <li>The <a href="full-index.html">Index</a> lists all properties, classes and modules</li>
+ <li>The <a href="help.html">Help</a> displays this page</li>
+ </ul>
+ <p>If JavaScript is enabled on your browser, a search field appears and allows you to search in all properties, classes and modules.</p>\r
+ </article>\r
+ \r
+ <article>\r
+ <h2>Overview</h2>\r
+ <p>The <a href="index.html">Overview</a> page is the front page of this documentation and provides a list of all modules with a summary for each.</p>\r
+ </article>\r
+ \r
+ <article>\r
+ <h2>Modules</h2>\r
+ <p>Each module has a page that contains a summary of the module, a graphic representation and a list of its classes (including interfaces) and properties. The left block contains a list of imported and nested modules.</p>\r
+ <p>If JavaScript is enabled on your browser, classes and properties can be filtered by name.</p>\r
+ </article>\r
+ \r
+ <article>\r
+ <h2>Class</h2>\r
+ <p>Each class and interface has its own separate page. Each of these pages has four sections consisting of a class/interface description, virtual and formal types list, detailed properties descriptions and inherited properties.</p>\r
+ <p>Blocks on the left display :</p>\r
+ <ul>\r
+ <li>Properties (virtual types, formal types, methods)</li>\r
+ <li>Inheritance relations (super and subclasses)</li>\r
+ </ul>\r
+ <p>Before the detail of each property an icon show the type of property (diamond = virtual type, square = constructor, circle = method). The color of the icon reflect the property visibility (red = private, orange = protected, green = public).</p>\r
+ </article>\r
+ \r
+ <article>\r
+ <h2>Index</h2>\r
+ <p>The <a href="full-index.html">Index</a> contains an alphabetic list of all modules, classes/interfaces and properties.</p>\r
+ <p>If JavaScript is enabled on your browser, lists can be filtered by name.</p>\r
+ </article>\r
+ </div> \r
+ <div class="clear"></div>\r
+ </div>\r
+ </body>\r
+</html>\r
nitlanguage / nit.git / commitdiff