docs/Bovem/CommandMethods/Help.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Bovem::CommandMethods::Help
— Documentation by YARD 0.9.7
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Bovem::CommandMethods::Help";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> »
<span class='title'><span class='object_link'><a href="../../Bovem.html" title="Bovem (module)">Bovem</a></span></span> » <span class='title'><span class='object_link'><a href="../CommandMethods.html" title="Bovem::CommandMethods (module)">CommandMethods</a></span></span>
»
<span class="title">Help</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Bovem::CommandMethods::Help
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../Command.html" title="Bovem::Command (class)">Bovem::Command</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/bovem/command.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Methods for showing help messages.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#show_help-instance_method" title="#show_help (instance method)">#<strong>show_help</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Shows a help about this command.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="show_help-instance_method">
#<strong>show_help</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Shows a help about this command.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15
16
17
18
19
20</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/bovem/command.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_show_help'>show_help</span>
<span class='id identifier rubyid_console'>console</span> <span class='op'>=</span> <span class='id identifier rubyid_application?'>application?</span> <span class='op'>?</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_console'>console</span> <span class='op'>:</span> <span class='id identifier rubyid_application'>application</span><span class='period'>.</span><span class='id identifier rubyid_console'>console</span>
<span class='id identifier rubyid_application?'>application?</span> <span class='op'>?</span> <span class='id identifier rubyid_show_help_application_summary'>show_help_application_summary</span><span class='lparen'>(</span><span class='id identifier rubyid_console'>console</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_show_help_command_summary'>show_help_command_summary</span><span class='lparen'>(</span><span class='id identifier rubyid_console'>console</span><span class='rparen'>)</span>
<span class='id identifier rubyid_show_help_banner'>show_help_banner</span><span class='lparen'>(</span><span class='id identifier rubyid_console'>console</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_banner?'>banner?</span>
<span class='id identifier rubyid_show_help_options'>show_help_options</span><span class='lparen'>(</span><span class='id identifier rubyid_console'>console</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_options?'>options?</span>
<span class='id identifier rubyid_show_help_commands'>show_help_commands</span><span class='lparen'>(</span><span class='id identifier rubyid_console'>console</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_commands?'>commands?</span>
<span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='int'>0</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jan 12 16:10:58 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.7 (ruby-2.3.0).
</div>
</div>
</body>
</html>