Skip to content

Commit

Permalink
docs: updates from Homebrew/brew
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewTestBot committed Jan 1, 2024
1 parent 578fd96 commit bd773c6
Show file tree
Hide file tree
Showing 67 changed files with 1,981 additions and 1,900 deletions.
11 changes: 11 additions & 0 deletions docs/ArchRequirement.html
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,17 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href="C



<h3 class="inherited">Methods included from <span class='object_link'><a href="Attrable.html" title="Attrable (module)">Attrable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Attrable.html#attr_predicate-instance_method" title="Attrable#attr_predicate (method)">#attr_predicate</a></span>, <span class='object_link'><a href="Attrable.html#attr_rw-instance_method" title="Attrable#attr_rw (method)">#attr_rw</a></span></p>









<h3 class="inherited">Methods included from <span class='object_link'><a href="Dependable.html" title="Dependable (module)">Dependable</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Dependable.html#build%3F-instance_method" title="Dependable#build? (method)">#build?</a></span>, <span class='object_link'><a href="Dependable.html#implicit%3F-instance_method" title="Dependable#implicit? (method)">#implicit?</a></span>, <span class='object_link'><a href="Dependable.html#option_tags-instance_method" title="Dependable#option_tags (method)">#option_tags</a></span>, <span class='object_link'><a href="Dependable.html#optional%3F-instance_method" title="Dependable#optional? (method)">#optional?</a></span>, <span class='object_link'><a href="Dependable.html#options-instance_method" title="Dependable#options (method)">#options</a></span>, <span class='object_link'><a href="Dependable.html#prune_from_option%3F-instance_method" title="Dependable#prune_from_option? (method)">#prune_from_option?</a></span>, <span class='object_link'><a href="Dependable.html#prune_if_build_and_not_dependent%3F-instance_method" title="Dependable#prune_if_build_and_not_dependent? (method)">#prune_if_build_and_not_dependent?</a></span>, <span class='object_link'><a href="Dependable.html#recommended%3F-instance_method" title="Dependable#recommended? (method)">#recommended?</a></span>, <span class='object_link'><a href="Dependable.html#required%3F-instance_method" title="Dependable#required? (method)">#required?</a></span>, <span class='object_link'><a href="Dependable.html#test%3F-instance_method" title="Dependable#test? (method)">#test?</a></span></p>
<div id="constructor_details" class="method_details_list">
Expand Down
295 changes: 295 additions & 0 deletions docs/Attrable.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,295 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Attrable

&mdash; Homebrew Ruby API

</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 = "Attrable";
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 (A)</a> &raquo;


<span class="title">Attrable</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: Attrable



</h1>
<div class="box_info">









<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="BottleSpecification.html" title="BottleSpecification (class)">BottleSpecification</a></span>, <span class='object_link'><a href="Cask/Artifact/AbstractArtifact.html" title="Cask::Artifact::AbstractArtifact (class)">Cask::Artifact::AbstractArtifact</a></span>, <span class='object_link'><a href="Cask/Audit.html" title="Cask::Audit (class)">Cask::Audit</a></span>, <span class='object_link'><a href="Cask/Cask.html" title="Cask::Cask (class)">Cask::Cask</a></span>, <span class='object_link'><a href="Cask/DSL.html" title="Cask::DSL (class)">Cask::DSL</a></span>, <span class='object_link'><a href="Cask/DSL/Caveats.html" title="Cask::DSL::Caveats (class)">Cask::DSL::Caveats</a></span>, <span class='object_link'><a href="Cask/Installer.html" title="Cask::Installer (class)">Cask::Installer</a></span>, <span class='object_link'><a href="Debrew.html" title="Debrew (module)">Debrew</a></span>, <span class='object_link'><a href="Formula.html" title="Formula (class)">Formula</a></span>, <span class='object_link'><a href="FormulaInstaller.html" title="FormulaInstaller (class)">FormulaInstaller</a></span>, <span class='object_link'><a href="Homebrew/Cleanup.html" title="Homebrew::Cleanup (class)">Homebrew::Cleanup</a></span>, <span class='object_link'><a href="Requirement.html" title="Requirement (class)">Requirement</a></span>, <span class='object_link'><a href="SystemCommand.html" title="SystemCommand (class)">SystemCommand</a></span></dd>
</dl>



<dl>
<dt>Defined in:</dt>
<dd>attrable.rb</dd>
</dl>

</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="#attr_predicate-instance_method" title="#attr_predicate (instance method)">#<strong>attr_predicate</strong>(*attrs) &#x21d2; void </a>


</span>








<span class="summary_desc"><div class='inline'>
</div></span>

</li>



<li class="public ">
<span class="summary_signature">

<a href="#attr_rw-instance_method" title="#attr_rw (instance method)">#<strong>attr_rw</strong>(*attrs) &#x21d2; void </a>


</span>








<span class="summary_desc"><div class='inline'>
</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="attr_predicate-instance_method">

#<strong>attr_predicate</strong>(*attrs) &#x21d2; <tt>void</tt>





</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>


</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>attrs</span>


<span class='type'>(<tt><span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>



</li>

</ul>


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


6
7
8
9
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'attrable.rb', line 6</span>

<span class='kw'>def</span> <span class='id identifier rubyid_attr_predicate'>attr_predicate</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
<span class='id identifier rubyid_attrs'>attrs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attr'>attr</span><span class='op'>|</span>
<span class='id identifier rubyid_define_method'>define_method</span> <span class='id identifier rubyid_attr'>attr</span> <span class='kw'>do</span>
<span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_sub'>sub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\?$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>==</span> <span class='kw'>true</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="attr_rw-instance_method">

#<strong>attr_rw</strong>(*attrs) &#x21d2; <tt>void</tt>





</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>


</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>attrs</span>


<span class='type'>(<tt><span class='object_link'><a href="Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>



</li>

</ul>


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


15
16
17
18
19
20
21</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'attrable.rb', line 15</span>

<span class='kw'>def</span> <span class='id identifier rubyid_attr_rw'>attr_rw</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_attrs'>attrs</span><span class='rparen'>)</span>
<span class='id identifier rubyid_attrs'>attrs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_attr'>attr</span><span class='op'>|</span>
<span class='id identifier rubyid_define_method'>define_method</span> <span class='id identifier rubyid_attr'>attr</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='op'>|</span>
<span class='id identifier rubyid_val'>val</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span> <span class='op'>?</span> <span class='id identifier rubyid_instance_variable_get'>instance_variable_get</span><span class='lparen'>(</span><span class='symbol'>:&quot;@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_instance_variable_set'>instance_variable_set</span><span class='lparen'>(</span><span class='symbol'>:&quot;@</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_attr'>attr</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>

</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
Loading

0 comments on commit bd773c6

Please sign in to comment.