sass-site/source/documentation/Sass/Script/Functions/Signature.html
2018-10-22 14:13:05 -07:00

593 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Sass::Script::Functions::Signature
&mdash; Documentation by YARD 0.9.12
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../../assets/css/docs.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../../';
framesUrl = "../../../frames.html#!Sass/Script/Functions/Signature.html";
</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 id="header">
<div id="menu">
<a href="../../../_index.html">Index (S)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Sass.html" title="Sass (module)">Sass</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Script.html" title="Sass::Script (module)">Script</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Functions.html" title="Sass::Script::Functions (module)">Functions</a></span></span>
&raquo;
<span class="title">Signature</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Sass::Script::Functions::Signature
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Struct</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Struct</li>
<li class="next">Sass::Script::Functions::Signature</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">.ruby-sass/lib/sass/script/functions.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A class representing a Sass function signature.</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="#args-instance_method" title="#args (instance method)">#<strong>args</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The names of the arguments to the function.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delayed_args-instance_method" title="#delayed_args (instance method)">#<strong>delayed_args</strong> &#x21d2; Array&lt;String&gt; </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>The names of the arguments whose evaluation should be delayed.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#deprecated-instance_method" title="#deprecated (instance method)">#<strong>deprecated</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute deprecated.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#var_args-instance_method" title="#var_args (instance method)">#<strong>var_args</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Whether the function takes a variable number of arguments.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#var_kwargs-instance_method" title="#var_kwargs (instance method)">#<strong>var_kwargs</strong> &#x21d2; Boolean </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Whether the function takes an arbitrary set of keyword arguments.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="args=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="args-instance_method">
#<strong>args</strong> &#x21d2; <tt>Array&lt;String&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The names of the arguments to the function.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of args</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/functions.rb', line 380</span>
<span class='kw'>def</span> <span class='id identifier rubyid_args'>args</span>
<span class='ivar'>@args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="delayed_args=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="delayed_args-instance_method">
#<strong>delayed_args</strong> &#x21d2; <tt>Array&lt;String&gt;</tt>
</h3><div class="docstring">
<div class="discussion">
<p>The names of the arguments whose evaluation should be delayed.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of delayed_args</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/functions.rb', line 380</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delayed_args'>delayed_args</span>
<span class='ivar'>@delayed_args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="deprecated=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="deprecated-instance_method">
#<strong>deprecated</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute deprecated</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of deprecated</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/functions.rb', line 380</span>
<span class='kw'>def</span> <span class='id identifier rubyid_deprecated'>deprecated</span>
<span class='ivar'>@deprecated</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="var_args=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="var_args-instance_method">
#<strong>var_args</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Whether the function takes a variable number of arguments.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of var_args</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/functions.rb', line 380</span>
<span class='kw'>def</span> <span class='id identifier rubyid_var_args'>var_args</span>
<span class='ivar'>@var_args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="var_kwargs=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="var_kwargs-instance_method">
#<strong>var_kwargs</strong> &#x21d2; <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Whether the function takes an arbitrary set of keyword arguments.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of var_kwargs</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
380
381
382</pre>
</td>
<td>
<pre class="code"><span class="info file"># File '.ruby-sass/lib/sass/script/functions.rb', line 380</span>
<span class='kw'>def</span> <span class='id identifier rubyid_var_kwargs'>var_kwargs</span>
<span class='ivar'>@var_kwargs</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Oct 22 13:20:52 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.5.3).
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-535380-14', 'sass-lang.com');
ga('send', 'pageview');
</script>
</body>
</html>