firedoc
Version:
API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and
1,326 lines (934 loc) • 39.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>utils</title>
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="../assets/vendor/yui-min.js"></script>
</head>
<body>
<div id="doc">
<header class="main-header">
<div class="content">
<div class="project-title">
<a href="http://docs-zh.fireball-x.com">
<img class="logo" src="http://docs-zh.fireball-x.com/images/logo.png" title="Fireball Engine API">
</a>
<h1 class="project-name">Fireball Engine API</h1>
<p class="description">Fireball is the game engine for the future.</p>
</div>
<ul class="jump-links">
<li><a href="#index" class="index-jump-link">index</a></li>
<li><a href="#top" class="top-jump-link">top</a></li>
</ul>
</div>
</header>
<div id="bd" class="main-body">
<div id="docs-sidebar" class="sidebar apidocs"><div id="api-list">
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
<li><a href="#api-enums">Enums</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/AST.html">AST</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/BuilderContext.html">BuilderContext</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ClazzExample.html">ClazzExample</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/DocParser.html">DocParser</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/DocView.html">DocView</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ExampleClass.html">ExampleClass</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/exampleModule.html" class="api-list-item-module">@exampleModule</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/Firedoc.html">Firedoc</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/Locals.html">Locals</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/ParserContext.html">ParserContext</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/firedoc.html" class="api-list-item-module">@firedoc</a>
</li>
<li>
<a class="class" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/classes/SecondClazz.html">SecondClazz</a>
<a href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/outmodules/undefinedmodule.html" class="api-list-item-module">@undefinedmodule</a>
</li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/exampleModule.html">exampleModule</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/firedoc.html">firedoc</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/helpers.html">helpers</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/mod1.html">mod1</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/mod2.html">mod2</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/submod1.html">submod1</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/submod2.html">submod2</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/undefinedmodule.html">undefinedmodule</a></li>
<li><a class="module" href="/Users/yorkie/workspace/firebox/firedoc/Users/yorkie/workspace/firebox/firedoc/out/modules/utils.html">utils</a></li>
</ul>
<ul id="api-enums" class="apis enums">
</ul>
</div>
</div>
</div>
</div>
<div id="docs-main" class="apidocs">
<div class="content container"><h1>utils Module</h1>
<div class="box clearfix meta">
<div class="foundat">
Defined in: <a href="../files/lib_locals.js.html#l13"><code>lib/locals.js:13</code></a>
</div>
</div>
<div class="box intro">
<p>Utilities modules</p>
</div>
<!-- Class member index -->
<div class="index-section properties">
<h3>Class</h3>
<ul class="index-list properties">
<li class="index-item">
<a href="classes/.html">
</a>
</li>
</ul>
</div>
<h3>Direct Members</h3>
<a name="index" class="anchor-link"></a>
<div class="index">
<h2>Index</h2>
<div id="api-options">
Show:
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#method_escapeHTML">escapeHTML</a>
</li>
<li class="index-item method">
<a href="#method_safetrim">safetrim</a>
</li>
<li class="index-item method">
<a href="#method_unindent">unindent</a>
</li>
<li class="index-item method">
<a href="#method_filterFileName">filterFileName</a>
</li>
<li class="index-item method">
<a href="#method_getLayouts">getLayouts</a>
</li>
<li class="index-item method">
<a href="#method_getPage">getPage</a>
</li>
<li class="index-item method">
<a href="#method_getPages">getPages</a>
</li>
<li class="index-item method">
<a href="#method_getPartials">getPartials</a>
</li>
<li class="index-item method">
<a href="#method_prepare">prepare</a>
</li>
<li class="index-item method">
<a href="#method_fixType">fixType</a>
</li>
<li class="index-item method">
<a href="#method_webpath">webpath</a>
</li>
<li class="index-item method">
<a href="#method_localize">localize</a>
</li>
<li class="index-item method">
<a href="#method_markdownLink">markdownLink</a>
</li>
<li class="index-item method">
<a href="#method_buildFileTree">buildFileTree</a>
</li>
</ul>
</div>
</div>
<div class="yui3-g">
<div class="yui3-u-1-2">
<h3>Methods:</h3>
<a name="method_escapeHTML" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>escapeHTML</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>html</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l22"><code>lib/utils.js:22</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Escapes HTML characters in <em>html</em>.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">html</code>
<span class="type">String</span>
<div class="param-description">
String to escape.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
Escaped string.
</p>
</div>
</div>
</div>
</div>
<a name="method_safetrim" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>safetrim</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>str</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l36"><code>lib/utils.js:36</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Trim in safe mode</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">str</code>
<span class="type">String</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
trimed string or other types if invalid
</p>
</div>
</div>
</div>
</div>
<a name="method_unindent" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>unindent</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>content</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l52"><code>lib/utils.js:52</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Normalizes the initial indentation of the given <em>content</em> so that the first line
is unindented, and all other lines are unindented to the same degree as the
first line. So if the first line has four spaces at the beginning, then all
lines will be unindented four spaces. Ported from <a href="https://github.com/rgrove/selleck">Selleck</a></p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">content</code>
<span class="type">String</span>
<div class="param-description">
Text to unindent.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
Unindented text.
</p>
</div>
</div>
</div>
</div>
<a name="method_filterFileName" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>filterFileName</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l71"><code>lib/utils.js:71</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Normalizes a file path to a writable filename:</p>
<p> var path = 'lib/file.js';
returns 'lib_file.js';</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type">String</span>
<div class="param-description">
The filename to normalize
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The filtered file path
</p>
</div>
</div>
</div>
</div>
<a name="method_getLayouts" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getLayouts</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dir</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l86"><code>lib/utils.js:86</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Like <code>getPages()</code>, but returns only the files under the <code>layout/</code> subdirectory
of the specified <em>dir</em>.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dir</code>
<span class="type">String</span>
<div class="param-description">
Directory path.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
Mapping of layout names to layout content.
</p>
</div>
</div>
</div>
</div>
<a name="method_getPage" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getPage</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>p</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String | null</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l100"><code>lib/utils.js:100</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Loads and returns the content of the specified page file.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">p</code>
<span class="type">String</span>
<div class="param-description">
Path to a single <code>.handlebars</code> page.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String | null</span>
<p>
Page content, or <code>null</code> if not found.
</p>
</div>
</div>
</div>
</div>
<a name="method_getPages" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getPages</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dir</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l117"><code>lib/utils.js:117</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Loads pages (files with a <code>.handlebars</code> extension) in the specified directory and
returns an object containing a mapping of page names (the part of the filename)
preceding the <code>.handlebars</code> extension) to page content.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dir</code>
<span class="type">String</span>
<div class="param-description">
Directory path.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
Mapping of page names to page content.
</p>
</div>
</div>
</div>
</div>
<a name="method_getPartials" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>getPartials</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>dir</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l160"><code>lib/utils.js:160</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Like <code>getPages()</code>, but returns only the files under the <code>partial/</code> subdirectory
of the specified <em>dir</em>.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">dir</code>
<span class="type">String</span>
<div class="param-description">
Directory path.
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
Mapping of partial names to partial content.
</p>
</div>
</div>
</div>
</div>
<a name="method_prepare" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>prepare</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>inDir</code>
</li>
<li class="arg">
<code>options</code>
</li>
<li class="arg">
<code>callback</code>
</li>
</ul><span class="paren">)</span>
</div>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l174"><code>lib/utils.js:174</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Mix/merge/munge data into the template.</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">inDir</code>
<span class="type">String</span>
<div class="param-description">
The starting directory
</div>
</li>
<li class="param">
<code class="param-name">options</code>
<span class="type">Object</span>
<div class="param-description">
The <code>options</code> for the meta data.
</div>
</li>
<li class="param">
<code class="param-name">callback</code>
<span class="type">callback</span>
<div class="param-description">
The callback to excecute when complete
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">err</code>
<span class="type">Error</span>
<div class="param-description">
</div>
</li>
<li class="param">
<code class="param-name">options</code>
<span class="type">Object</span>
<div class="param-description">
Merged options.
</div>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<a name="method_fixType" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>fixType</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>t</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l253"><code>lib/utils.js:253</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Takes a type string and converts it to a "First letter upper cased" type.
e.g. <code>(string -> String, object -> Object)</code></p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">t</code>
<span class="type">String</span>
<div class="param-description">
The type string to convert
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The fixed string
</p>
</div>
</div>
</div>
</div>
<a name="method_webpath" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>webpath</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>url</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l276"><code>lib/utils.js:276</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Produces a normalized web path by joining all the parts and normalizing the
filesystem-like path into web compatible url.
Supports relative and absolute paths.
Courtesy of <a href="https://github.com/yahoo/mojito/">Mojito's utils</a></p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">url</code>
<span class="type">Array | String</span>
<div class="param-description">
the list of parts to be joined and normalized
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
The joined and normalized url
</p>
</div>
</div>
</div>
</div>
<a name="method_localize" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>localize</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>str</code>
</li>
<li class="arg">
<code>lang</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l293"><code>lib/utils.js:293</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>Localize the string via current Y.options</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">str</code>
<span class="type">String</span>
<div class="param-description">
the original string that you want to input
</div>
</li>
<li class="param">
<code class="param-name">lang</code>
<span class="type">String</span>
<div class="param-description">
the language
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
localized string from the param <code>str</code>
</p>
</div>
</div>
</div>
</div>
<a name="method_markdownLink" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>markdownLink</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>str</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">String</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l333"><code>lib/utils.js:333</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>convert string to markdown link</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">str</code>
<span class="type">String</span>
<div class="param-description">
The original string that you want to input
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">String</span>
<p>
marked string from the param <code>str</code>
</p>
</div>
</div>
</div>
</div>
<a name="method_buildFileTree" class="anchor-link"></a>
<div class="method item">
<h3 class="name"><code>buildFileTree</code>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>files</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type">Object</span>
</span>
</h3>
<div class="meta">
<p>Provided by the <a href="../modules/utils.html" class="module-name">utils</a> module.</p>
<p>
Defined in
<a href="../files/lib_utils.js.html#l348"><code>lib/utils.js:348</code></a>
</p>
</div>
<div class="extended-detail">
<div class="description">
<p>build file tree object</p>
</div>
<div class="params">
<h4>parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">files</code>
<span class="type">Array</span>
<div class="param-description">
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>returns:</h4>
<div class="returns-description">
<span>type:</span>
<span class="type">Object</span>
<p>
</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/vendor/jquery.min.js"></script>
<script src="../assets/js/jquery-offscreen-trigger.js"></script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>