<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Doing::Completion::BashCompletions
— Documentation by YARD 0.9.34
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::Completion::BashCompletions";
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 (B)</a> »
<span class='title'><span class='object_link'><a href="../../Doing.html" title="Doing (module)">Doing</a></span></span> » <span class='title'><span class='object_link'><a href="../Completion.html" title="Doing::Completion (module)">Completion</a></span></span>
»
<span class="title">BashCompletions</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>Class: Doing::Completion::BashCompletions
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></span>
<ul class="fullTree">
<li><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></li>
<li class="next">Doing::Completion::BashCompletions</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/completion/bash_completion.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Generate completions for Bash</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#commands-instance_method" title="#commands (instance method)">#<strong>commands</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute commands.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#global_options-instance_method" title="#global_options (instance method)">#<strong>global_options</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute global_options.</p>
</div></span>
</li>
</ul>
<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="#command_function-instance_method" title="#command_function (instance method)">#<strong>command_function</strong>(command, options, type) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#generate_completions-instance_method" title="#generate_completions (instance method)">#<strong>generate_completions</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_words-instance_method" title="#get_words (instance method)">#<strong>get_words</strong>(type) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ BashCompletions </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of BashCompletions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#main_function-instance_method" title="#main_function (instance method)">#<strong>main_function</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Doing::Completion::BashCompletions (class)">BashCompletions</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of BashCompletions.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="commands=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="commands-instance_method">
#<strong>commands</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute commands.</p>
</div>
</div>
<div class="tags">
</div>
</div>
<span id="global_options=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="global_options-instance_method">
#<strong>global_options</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute global_options.</p>
</div>
</div>
<div class="tags">
</div>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="command_function-instance_method">
#<strong>command_function</strong>(command, options, type) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="generate_completions-instance_method">
#<strong>generate_completions</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="get_words-instance_method">
#<strong>get_words</strong>(type) ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="main_function-instance_method">
#<strong>main_function</strong> ⇒ <tt><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Jul 1 12:43:15 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.34 (ruby-3.2.0).
</div>
</div>
</body>
</html>