Files
Sourcery/docs/docsets/Sourcery.docset/Contents/Resources/Documents/Classes/MethodParameter.html
T
2017-04-11 20:31:58 +02:00

578 lines
28 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>MethodParameter Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/MethodParameter" class="dashAnchor"></a>
<a title="MethodParameter Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Sourcery Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/krzysztofzablocki/Sourcery"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">Sourcery Reference</a>
<img id="carat" src="../img/carat.png" />
MethodParameter Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Guides.html">Guides</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../installing.html">Installing</a>
</li>
<li class="nav-group-task">
<a href="../usage.html">Usage</a>
</li>
<li class="nav-group-task">
<a href="../writing-templates.html">Writing templates</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Examples.html">Examples</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../equatable.html">Equatable</a>
</li>
<li class="nav-group-task">
<a href="../hashable.html">Hashable</a>
</li>
<li class="nav-group-task">
<a href="../enum-cases.html">Enum cases</a>
</li>
<li class="nav-group-task">
<a href="../lenses.html">Lenses</a>
</li>
<li class="nav-group-task">
<a href="../mocks.html">Mocks</a>
</li>
<li class="nav-group-task">
<a href="../diffable.html">Diffable</a>
</li>
<li class="nav-group-task">
<a href="../linuxmain.html">LinuxMain</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Types.html">Types</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/TypesReflectionBox.html">TypesReflectionBox</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Type.html">Type</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Protocol.html">Protocol</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Class.html">Class</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Struct.html">Struct</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Enum.html">Enum</a>
</li>
<li class="nav-group-task">
<a href="../Classes/EnumCase.html">EnumCase</a>
</li>
<li class="nav-group-task">
<a href="../Classes/AssociatedValue.html">AssociatedValue</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Variable.html">Variable</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Method.html">Method</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MethodParameter.html">MethodParameter</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TypeName.html">TypeName</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TupleType.html">TupleType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/TupleElement.html">TupleElement</a>
</li>
<li class="nav-group-task">
<a href="../Classes/ArrayType.html">ArrayType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/DictionaryType.html">DictionaryType</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Attribute.html">Attribute</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Other Protocols.html">Other Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/Annotated.html">Annotated</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/Typed.html">Typed</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>MethodParameter</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">MethodParameter</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">SourceryModel</span><span class="p">,</span> <span class="kt"><a href="../Protocols/Typed.html">Typed</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/Annotated.html">Annotated</a></span></code></pre>
</div>
</div>
<p>Describes method parameter</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter13argumentLabelGSqSS_"></a>
<a name="//apple_ref/swift/Property/argumentLabel" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter13argumentLabelGSqSS_">argumentLabel</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parameter external name</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">argumentLabel</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter4nameSS"></a>
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter4nameSS">name</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parameter internal name</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter8typeNameCS_8TypeName"></a>
<a name="//apple_ref/swift/Property/typeName" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter8typeNameCS_8TypeName">typeName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parameter type name</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">typeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</a></span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter4typeGSqCS_4Type_"></a>
<a name="//apple_ref/swift/Property/type" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter4typeGSqCS_4Type_">type</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parameter type, if known</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">type</span><span class="p">:</span> <span class="k">Type</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter14typeAttributesGVs10DictionarySSCS_9Attribute_"></a>
<a name="//apple_ref/swift/Property/typeAttributes" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter14typeAttributesGVs10DictionarySSCS_9Attribute_">typeAttributes</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parameter type attributes, i.e. <code>@escaping</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">typeAttributes</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt"><a href="../Classes/Attribute.html">Attribute</a></span><span class="p">]</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter12defaultValueGSqSS_"></a>
<a name="//apple_ref/swift/Property/defaultValue" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter12defaultValueGSqSS_">defaultValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Method parameter default value expression</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">defaultValue</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter11annotationsGVs10DictionarySSCSo8NSObject_"></a>
<a name="//apple_ref/swift/Property/annotations" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter11annotationsGVs10DictionarySSCSo8NSObject_">annotations</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Annotations, that were created with // sourcery: annotation1, other = <q>annotation value</q>, alterantive = 2</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">internal(set)</span> <span class="k">var</span> <span class="nv">annotations</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">]</span> <span class="o">=</span> <span class="p">[:]</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter10isOptionalSb"></a>
<a name="//apple_ref/swift/Property/isOptional" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter10isOptionalSb">isOptional</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is optional. Shorthand for <code>typeName.isOptional</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isOptional</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter29isImplicitlyUnwrappedOptionalSb"></a>
<a name="//apple_ref/swift/Property/isImplicitlyUnwrappedOptional" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter29isImplicitlyUnwrappedOptionalSb">isImplicitlyUnwrappedOptional</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is implicitly unwrapped optional. Shorthand for <code>typeName.isImplicitlyUnwrappedOptional</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isImplicitlyUnwrappedOptional</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter17unwrappedTypeNameSS"></a>
<a name="//apple_ref/swift/Property/unwrappedTypeName" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter17unwrappedTypeNameSS">unwrappedTypeName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Type name without attributes and optional type information. Shorthand for <code>typeName.unwrappedTypeName</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">unwrappedTypeName</span><span class="p">:</span> <span class="kt">String</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter14actualTypeNameGSqCS_8TypeName_"></a>
<a name="//apple_ref/swift/Property/actualTypeName" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter14actualTypeNameGSqCS_8TypeName_">actualTypeName</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Actual type name if declaration uses typealias, otherwise just a <code><a href="../Classes/MethodParameter.html#/s:vC8Sourcery15MethodParameter8typeNameCS_8TypeName">typeName</a></code>. Shorthand for <code>typeName.actualTypeName</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">actualTypeName</span><span class="p">:</span> <span class="kt"><a href="../Classes/TypeName.html">TypeName</a></span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter7isTupleSb"></a>
<a name="//apple_ref/swift/Property/isTuple" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter7isTupleSb">isTuple</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is a tuple. Shorthand for <code>typeName.isTuple</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isTuple</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter9isClosureSb"></a>
<a name="//apple_ref/swift/Property/isClosure" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter9isClosureSb">isClosure</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is a closure. Shorthand for <code>typeName.isClosure</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isClosure</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter7isArraySb"></a>
<a name="//apple_ref/swift/Property/isArray" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter7isArraySb">isArray</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is an array. Shorthand for <code>typeName.isArray</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isArray</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vC8Sourcery15MethodParameter12isDictionarySb"></a>
<a name="//apple_ref/swift/Property/isDictionary" class="dashAnchor"></a>
<a class="token" href="#/s:vC8Sourcery15MethodParameter12isDictionarySb">isDictionary</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Whether type is a dictionary. Shorthand for <code>typeName.isDictionary</code></p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isDictionary</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>Copyright © 2016 Pixle. All rights reserved.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>