Skip to content

Update documentation #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2017
Merged

Update documentation #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 36 additions & 4 deletions docs/Classes.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,9 @@
<li class="nav-group-task">
<a href="Enums/ByteOrder.html">ByteOrder</a>
</li>
<li class="nav-group-task">
<a href="Enums/CallingConvention.html">CallingConvention</a>
</li>
<li class="nav-group-task">
<a href="Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
</li>
Expand All @@ -85,6 +88,9 @@
<li class="nav-group-task">
<a href="Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:O4LLVM8Floating">Floating</a>
</li>
<li class="nav-group-task">
<a href="Enums/FunctionPass.html">FunctionPass</a>
</li>
Expand Down Expand Up @@ -115,9 +121,15 @@
<li class="nav-group-task">
<a href="Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:O4LLVM6Signed">Signed</a>
</li>
<li class="nav-group-task">
<a href="Enums/TargetMachineError.html">TargetMachineError</a>
</li>
<li class="nav-group-task">
<a href="Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="Enums/Visibility.html">Visibility</a>
</li>
Expand Down Expand Up @@ -167,9 +179,23 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="Protocols/IRGlobal.html">IRGlobal</a>
</li>
Expand All @@ -179,6 +205,9 @@
<li class="nav-group-task">
<a href="Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -193,6 +222,9 @@
<li class="nav-group-task">
<a href="Structs/BasicBlock.html">BasicBlock</a>
</li>
<li class="nav-group-task">
<a href="Structs/Constant.html">Constant</a>
</li>
<li class="nav-group-task">
<a href="Structs/FunctionType.html">FunctionType</a>
</li>
Expand Down Expand Up @@ -437,11 +469,11 @@ <h4>Declaration</h4>
provides simple methods for reading files and standard input into a memory
buffer. In addition to basic access to the characters in the file, this
interface guarantees you can read one character past the end of the file,
and that this character will read as &rsquo;\0&rsquo;.</p>
and that this character will read as &lsquo;\0&rsquo;.</p>

<p>The &rsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
<p>The &lsquo;\0&rsquo; guarantee is needed to support an optimization &ndash; it&rsquo;s intended to
be more efficient for clients which are reading all the data to stop
reading when they encounter a &rsquo;\0&rsquo; than to continually check the file
reading when they encounter a &lsquo;\0&rsquo; than to continually check the file
position to see if it has reached the end of the file.</p>

<a href="Classes/MemoryBuffer.html" class="slightly-smaller">See more</a>
Expand Down Expand Up @@ -593,7 +625,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
34 changes: 33 additions & 1 deletion docs/Classes/Context.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@
<li class="nav-group-task">
<a href="../Enums/ByteOrder.html">ByteOrder</a>
</li>
<li class="nav-group-task">
<a href="../Enums/CallingConvention.html">CallingConvention</a>
</li>
<li class="nav-group-task">
<a href="../Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
</li>
Expand All @@ -86,6 +89,9 @@
<li class="nav-group-task">
<a href="../Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FunctionPass.html">FunctionPass</a>
</li>
Expand Down Expand Up @@ -116,9 +122,15 @@
<li class="nav-group-task">
<a href="../Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
</li>
<li class="nav-group-task">
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Visibility.html">Visibility</a>
</li>
Expand Down Expand Up @@ -168,9 +180,23 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
</li>
Expand All @@ -180,6 +206,9 @@
<li class="nav-group-task">
<a href="../Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -194,6 +223,9 @@
<li class="nav-group-task">
<a href="../Structs/BasicBlock.html">BasicBlock</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constant.html">Constant</a>
</li>
<li class="nav-group-task">
<a href="../Structs/FunctionType.html">FunctionType</a>
</li>
Expand Down Expand Up @@ -321,7 +353,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
61 changes: 60 additions & 1 deletion docs/Classes/Function.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,9 @@
<li class="nav-group-task">
<a href="../Enums/ByteOrder.html">ByteOrder</a>
</li>
<li class="nav-group-task">
<a href="../Enums/CallingConvention.html">CallingConvention</a>
</li>
<li class="nav-group-task">
<a href="../Enums/CodeGenOptLevel.html">CodeGenOptLevel</a>
</li>
Expand All @@ -86,6 +89,9 @@
<li class="nav-group-task">
<a href="../Enums/FloatType.html">FloatType</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Floating">Floating</a>
</li>
<li class="nav-group-task">
<a href="../Enums/FunctionPass.html">FunctionPass</a>
</li>
Expand Down Expand Up @@ -116,9 +122,15 @@
<li class="nav-group-task">
<a href="../Enums/RelocMode.html">RelocMode</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM6Signed">Signed</a>
</li>
<li class="nav-group-task">
<a href="../Enums/TargetMachineError.html">TargetMachineError</a>
</li>
<li class="nav-group-task">
<a href="../Enums.html#/s:O4LLVM8Unsigned">Unsigned</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Visibility.html">Visibility</a>
</li>
Expand Down Expand Up @@ -168,9 +180,23 @@
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Functions.html">Functions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_6Signed_GS0_S1__">-(_:)</a>
</li>
<li class="nav-group-task">
<a href="../Functions.html#/s:F4LLVMop1sFGVS_8ConstantOS_8Floating_GS0_S1__">-(_:)</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM22ConstantRepresentation">ConstantRepresentation</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/IRGlobal.html">IRGlobal</a>
</li>
Expand All @@ -180,6 +206,9 @@
<li class="nav-group-task">
<a href="../Protocols/IRValue.html">IRValue</a>
</li>
<li class="nav-group-task">
<a href="../Protocols.html#/s:P4LLVM30IntegralConstantRepresentation">IntegralConstantRepresentation</a>
</li>
</ul>
</li>
<li class="nav-group-name">
Expand All @@ -194,6 +223,9 @@
<li class="nav-group-task">
<a href="../Structs/BasicBlock.html">BasicBlock</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Constant.html">Constant</a>
</li>
<li class="nav-group-task">
<a href="../Structs/FunctionType.html">FunctionType</a>
</li>
Expand Down Expand Up @@ -264,6 +296,33 @@ <h1>Function</h1>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vC4LLVM8Function17callingConventionOS_17CallingConvention"></a>
<a name="//apple_ref/swift/Property/callingConvention" class="dashAnchor"></a>
<a class="token" href="#/s:vC4LLVM8Function17callingConventionOS_17CallingConvention">callingConvention</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Accesses the calling convention for this function.</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">callingConvention</span><span class="p">:</span> <span class="kt"><a href="../Enums/CallingConvention.html">CallingConvention</a></span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -693,7 +752,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-15)</p>
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-01-27)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading