documon
Version:
A documentation system for mortals. Use with any language.
567 lines (323 loc) • 24.7 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>documon</title>
<meta name="description" content="documon">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "documon",
name: "documon"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<a name="properties"></a>
<div class="part-properties">
<div class="heading-part">Classes</div>
<div class="member">
<div class="member-block-group">
<div class="member-block" >
<div class="member-block-left">
<a name="documon.Access"></a><a name="Access"></a>
<span class="member-name"><a href="documon.Access.html#documon.Access">Access</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/template/assets/js/documon/Access.js</span>
<p>Toggles member parts inheritance, private/public and protected in the menu and on the pages.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.Main"></a><a name="Main"></a>
<span class="member-name"><a href="documon.Main.html#documon.Main">Main</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/template/assets/js/documon/Main.js</span>
<p>THe main entry point for initializing other classes.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.Search"></a><a name="Search"></a>
<span class="member-name"><a href="documon.Search.html#documon.Search">Search</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/template/assets/js/documon/Search.js</span>
<p>Provides the search mechanism across the documentation.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.dirutils"></a><a name="dirutils"></a>
<span class="member-name"><a href="documon.dirutils.html#documon.dirutils">dirutils</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/dirutils.js</span>
<p>A collection of utilities for manipulating directories syncronously.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.documon"></a><a name="documon"></a>
<span class="member-name"><a href="documon.documon.html#documon.documon">documon</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/documon.js</span>
<p>The main entry point and processor for Documon, which allows you to run Documon directly from Node.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.extract"></a><a name="extract"></a>
<span class="member-name"><a href="documon.extract.html#documon.extract">extract</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/extract.js</span>
<p>Extracts comments from a file into an array or mulit-dementional array when the "text" arg contains mulitple <strong>package</strong> or <strong>namepsace</strong> definitions.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.fileutils"></a><a name="fileutils"></a>
<span class="member-name"><a href="documon.fileutils.html#documon.fileutils">fileutils</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/fileutils.js</span>
<p>Basic, common and simplified asyncronous file methods.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.info"></a><a name="info"></a>
<span class="member-name"><a href="documon.info.html#documon.info">info</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/info.js</span>
<p>A place to store text-heavy data for copyright and CLI usage information.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.log"></a><a name="log"></a>
<span class="member-name"><a href="documon.log.html#documon.log">log</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/log.js</span>
<p>Writes to the console. Will accept an object or array as well as string, boolena and other and prepare them for proper presentation to the console.</p>
</div>
</div>
</div>
<div class="member-block" data-access="private" >
<div class="member-block-left">
<a name="documon.menuBuilder"></a><a name="menuBuilder"></a>
<span class="member-name"><a href="documon.menuBuilder.html#documon.menuBuilder">menuBuilder</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/menuBuilder.js</span>
<span class="flag private">private</span> <!-- public private protected -->
<p>Takes the source context object (which contains the entire resolved documentation data) and extracts meta data adn refactors / organizes it into an object formatted for "MenuTree.js".</p>
</div>
</div>
</div>
<div class="member-block" data-access="private" >
<div class="member-block-left">
<a name="documon.mimimist"></a><a name="mimimist"></a>
<span class="member-name"><a href="documon.mimimist.html#documon.mimimist">mimimist</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/minimist.js</span>
<span class="flag private">private</span> <!-- public private protected -->
<p>A localized version of mimimist (minimist has no dependancies), for processing CLI arguments.</p>
</div>
</div>
</div>
<div class="member-block" data-access="private" >
<div class="member-block-left">
<a name="documon.More"></a><a name="More"></a>
<span class="member-name"><a href="documon.More.html#documon.More">More</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/more.js</span>
<span class="flag private">private</span> <!-- public private protected -->
<p>Discovers, parses, converts markdown to HTML and injects menu with "more" docs.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.npath"></a><a name="npath"></a>
<span class="member-name"><a href="documon.npath.html#documon.npath">npath</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/npath.js</span>
<p>A drop-in replacement for path, that provides cross-playform normalization. Easing the development of cross-platform modules.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.opn"></a><a name="opn"></a>
<span class="member-name"><a href="documon.opn.html#documon.opn">opn</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/opn.js</span>
<p>A cross-platform way to launch files from Node.</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.organizer"></a><a name="organizer"></a>
<span class="member-name"><a href="documon.organizer.html#documon.organizer">organizer</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/organizer.js</span>
<p>Organizes the parsed source-code data into a single object that takes the following form:</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.parseFlags"></a><a name="parseFlags"></a>
<span class="member-name"><a href="documon.parseFlags.html#documon.parseFlags">parseFlags</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/parseFlag.js</span>
<p>Fills the output object with the following properties (if they exist)</p>
</div>
</div>
</div>
<div class="member-block" data-access="private" >
<div class="member-block-left">
<a name="documon.searchPrep"></a><a name="searchPrep"></a>
<span class="member-name"><a href="documon.searchPrep.html#documon.searchPrep">searchPrep</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/searchPrep.js</span>
<span class="flag private">private</span> <!-- public private protected -->
<p>Clean text so it has:</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.tag"></a><a name="tag"></a>
<span class="member-name"><a href="documon.tag.html#documon.tag">tag</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/tag.js</span>
<p>Processes the following flags</p>
</div>
</div>
</div>
<div class="member-block" >
<div class="member-block-left">
<a name="documon.utils"></a><a name="utils"></a>
<span class="member-name"><a href="documon.utils.html#documon.utils">utils</a></span>
</div>
<div class="member-block-center">
<span class="member-name-right">
</span>
<div class="param-description">
<span class="list-filepath">documon/src/utils.js</span>
<p>A collection of useful helper untilities.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="parts">
<a name="properties"></a>
</div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>