227 lines
5.8 KiB
HTML
227 lines
5.8 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset='UTF-8'>
|
||
|
|
<title>Atom-Beautify Documentation</title>
|
||
|
|
<script src='../javascript/application.js'></script>
|
||
|
|
<script src='../javascript/search.js'></script>
|
||
|
|
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id='base' data-path='../'></div>
|
||
|
|
<div id='header'>
|
||
|
|
<div id='menu'>
|
||
|
|
<a href='../extra/README.md.html' title='Atom-Beautify'>
|
||
|
|
Atom-Beautify
|
||
|
|
</a>
|
||
|
|
»
|
||
|
|
<a href='../alphabetical_index.html' title='Index'>
|
||
|
|
Index
|
||
|
|
</a>
|
||
|
|
»
|
||
|
|
<span class='title'>VhdlBeautifier</span>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id='content'>
|
||
|
|
<h1>
|
||
|
|
Class:
|
||
|
|
VhdlBeautifier
|
||
|
|
</h1>
|
||
|
|
<table class='box'>
|
||
|
|
<tr>
|
||
|
|
<td>Defined in:</td>
|
||
|
|
<td>src/beautifiers/vhdl-beautifier/index.coffee</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>Inherits:</td>
|
||
|
|
<td>
|
||
|
|
<a href='../class/Beautifier.html'>Beautifier</a>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
<h2>Variables Summary</h2>
|
||
|
|
<dl class='constants'>
|
||
|
|
<dt id='name-variable'>
|
||
|
|
name
|
||
|
|
=
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
<pre><code class='coffeescript'>"VHDL Beautifier"</code></pre>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id='link-variable'>
|
||
|
|
link
|
||
|
|
=
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
<pre><code class='coffeescript'>"https://www.gnu.org/software/emacs/"</code></pre>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id='executables-variable'>
|
||
|
|
executables
|
||
|
|
=
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
<pre><code class='coffeescript'>[
|
||
|
|
{
|
||
|
|
name: "Emacs",
|
||
|
|
cmd: "emacs",
|
||
|
|
homepage: "https://www.gnu.org/software/emacs/",
|
||
|
|
installation: "https://www.gnu.org/software/emacs/",
|
||
|
|
version: {
|
||
|
|
parse: function(text) {
|
||
|
|
return text.match(/Emacs (\d+\.\d+\.\d+)/)[1];
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
]</code></pre>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
<dt id='options-variable'>
|
||
|
|
options
|
||
|
|
=
|
||
|
|
</dt>
|
||
|
|
<dd>
|
||
|
|
<pre><code class='coffeescript'>{
|
||
|
|
VHDL: {
|
||
|
|
emacs_script_path: true
|
||
|
|
}
|
||
|
|
}</code></pre>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<h3 class='inherited'>
|
||
|
|
Variable inherited from
|
||
|
|
<a href='../class/Beautifier.html'>Beautifier</a>
|
||
|
|
</h3>
|
||
|
|
<p class='inherited'>
|
||
|
|
<a href='../class/Beautifier.html#Promise-variable'>Promise</a>
|
||
|
|
<a href='../class/Beautifier.html#name-variable'>name</a>
|
||
|
|
<a href='../class/Beautifier.html#options-variable'>options</a>
|
||
|
|
<a href='../class/Beautifier.html#executables-variable'>executables</a>
|
||
|
|
<a href='../class/Beautifier.html#_exe-variable'>_exe</a>
|
||
|
|
<a href='../class/Beautifier.html#languages-variable'>languages</a>
|
||
|
|
<a href='../class/Beautifier.html#beautify-variable'>beautify</a>
|
||
|
|
<a href='../class/Beautifier.html#logger-variable'>logger</a>
|
||
|
|
</p>
|
||
|
|
<h2>Instance Method Summary</h2>
|
||
|
|
<ul class='summary'>
|
||
|
|
<li>
|
||
|
|
<span class='signature'>
|
||
|
|
<a href='#beautify-dynamic'>
|
||
|
|
#
|
||
|
|
(void)
|
||
|
|
<b>beautify</b><span>(text, language, options)</span>
|
||
|
|
</a>
|
||
|
|
</span>
|
||
|
|
<span class='desc'>
|
||
|
|
</span>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2>
|
||
|
|
<small>Inherited Method Summary</small>
|
||
|
|
<h3 class='inherited'>
|
||
|
|
Methods inherited from
|
||
|
|
<a href='../class/Beautifier.html'>Beautifier</a>
|
||
|
|
</h3>
|
||
|
|
<p class='inherited'>
|
||
|
|
<a href='../class/Beautifier.html#isPreInstalled-dynamic'>#isPreInstalled</a>
|
||
|
|
<a href='../class/Beautifier.html#loadExecutables-dynamic'>#loadExecutables</a>
|
||
|
|
<a href='../class/Beautifier.html#exe-dynamic'>#exe</a>
|
||
|
|
<a href='../class/Beautifier.html#deprecate-dynamic'>#deprecate</a>
|
||
|
|
<a href='../class/Beautifier.html#deprecateOptionForExecutable-dynamic'>#deprecateOptionForExecutable</a>
|
||
|
|
<a href='../class/Beautifier.html#tempFile-dynamic'>#tempFile</a>
|
||
|
|
<a href='../class/Beautifier.html#readFile-dynamic'>#readFile</a>
|
||
|
|
<a href='../class/Beautifier.html#findFile-dynamic'>#findFile</a>
|
||
|
|
<a href='../class/Beautifier.html#getDefaultLineEnding-dynamic'>#getDefaultLineEnding</a>
|
||
|
|
<a href='../class/Beautifier.html#which-dynamic'>#which</a>
|
||
|
|
<a href='../class/Beautifier.html#run-dynamic'>#run</a>
|
||
|
|
<a href='../class/Beautifier.html#setupLogger-dynamic'>#setupLogger</a>
|
||
|
|
</p>
|
||
|
|
</h2>
|
||
|
|
<h2>Instance Method Details</h2>
|
||
|
|
<div class='methods'>
|
||
|
|
<div class='method_details'>
|
||
|
|
<p class='signature' id='beautify-dynamic'>
|
||
|
|
#
|
||
|
|
(void)
|
||
|
|
<b>beautify</b><span>(text, language, options)</span>
|
||
|
|
<br>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id='footer'>
|
||
|
|
By
|
||
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||
|
|
Codo
|
||
|
|
</a>
|
||
|
|
2.1.2
|
||
|
|
✲
|
||
|
|
Press H to see the keyboard shortcuts
|
||
|
|
✲
|
||
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
||
|
|
✲
|
||
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
||
|
|
</div>
|
||
|
|
<iframe id='search_frame'></iframe>
|
||
|
|
<div id='fuzzySearch'>
|
||
|
|
<input type='text'>
|
||
|
|
<ol></ol>
|
||
|
|
</div>
|
||
|
|
<div id='help'>
|
||
|
|
<p>
|
||
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<span>T</span>
|
||
|
|
Open fuzzy finder dialog
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>
|
||
|
|
Control the navigation frame:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<span>L</span>
|
||
|
|
Toggle list view
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>C</span>
|
||
|
|
Show class list
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>I</span>
|
||
|
|
Show mixin list
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>F</span>
|
||
|
|
Show file list
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>M</span>
|
||
|
|
Show method list
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>E</span>
|
||
|
|
Show extras list
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>
|
||
|
|
You can focus and blur the search input:
|
||
|
|
</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<span>S</span>
|
||
|
|
Focus search input
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<span>Esc</span>
|
||
|
|
Blur search input
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|