Selaa lähdekoodia

docs: Updated to latest version

Ole 9 vuotta sitten
vanhempi
commit
709f3f716e

+ 12 - 10
docs/mkdocs/advanced.md

@@ -1,11 +1,11 @@
-# Operating on Lua values with C++ functions
+# Advanced stack interaction
 Instead of extracting every Lua value seperately and pushing the result of your C++ function back
-onto the stack again, you can use one of the following functions to make this process easier for you.
+onto the stack again, you can use one of the following functions to make this process easier for
+you.
 
 ## Invoke a Callable with Lua values
-The function [direct<S>](/reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a)
-lets you specify a *stack signature* in order to extract the values and invoke a `Callable` with
-them.
+The function [direct][luwra-direct] lets you specify a *stack signature* in order to extract the
+values and invoke a `Callable` with them.
 
 Consider the following:
 
@@ -23,11 +23,10 @@ string result = luwra::direct<string(string, int)>(lua, n, foo);
 everything happens on the C++ side.
 
 ## Invoke a function with Lua values
-[apply](/reference/namespaceluwra.html#a839077ddd9c3d0565a40c574bc8e9555) is similiar to
-[direct](/reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a). The function `apply`
-provides specific overloads for function pointers and function objects. Although `direct` works
-with function pointers and function objects, it is often more convenient to use `apply` since it
-allows the compiler to infer the *stack signature* without providing a template parameter.
+[apply][luwra-apply] is similiar to [direct][luwra-direct]. It differs from `direct` by providing
+specific overloads for function pointers and function objects. Although `direct` works with function pointers
+and function objects, it is often more convenient to use `apply` since it allows the compiler to
+infer the *stack signature* without providing a template parameter.
 
 Provided a function `foo` which has been declared as used in the example above:
 
@@ -43,3 +42,6 @@ One would use `foo` like this:
 ```c++
 string result = luwra::apply(lua, n, foo);
 ```
+
+[luwra-direct]: /reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a
+[luwra-apply]: /reference/namespaceluwra.html#a839077ddd9c3d0565a40c574bc8e9555

+ 7 - 6
docs/mkdocs/stack-interaction.md

@@ -57,8 +57,8 @@ namespace luwra {
 ```
 
 ## Pushing C++ values
-When pushing values onto the stack you can either use [Value&lt;T&gt;::push][luwra-value-push] or
-the more convenient [push][luwra-push].
+When pushing values onto the stack you can either use `Value<T>::push` or the more convenient
+[push][luwra-push].
 
 ```c++
 // Push an integer
@@ -97,8 +97,9 @@ Absolute Position | Relative Position | Value
 4                 | -2                | `"Hello World"`
 5                 | -1                | `{one = 1, [1] = "one", nested = {more = "fields"}}`
 
-It is possible to provide a template parameter to `push` to enforce pushing a specific type.
-In most cases you are probably better off by letting the compiler infer the template parameter.
+It is possible to provide a template parameter to [push][luwra-push] to enforce pushing a specific
+type. In most cases you are probably better off by letting the compiler infer the template
+parameter.
 
 ## Reading Lua values
 Simple retrieval of Lua values is done using [read&lt;T&gt;][luwra-read]. Consider the stack layout
@@ -122,9 +123,9 @@ information.
 [lua-cfunction]: http://www.lua.org/manual/5.3/manual.html#lua_CFunction
 [lua-errorhandling]: http://www.lua.org/manual/5.3/manual.html#4.6
 [luwra-value]: /reference/structluwra_1_1Value.html
-[luwra-nativefunction]: /reference/structluwra_1_1NativeFunction_3_01R_07A_8_8_8_08_4.html
+[luwra-nativefunction]: /reference/structluwra_1_1NativeFunction.html
 [luwra-table]: /reference/structluwra_1_1Table.html
 [luwra-read]: /reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab
 [luwra-value-push]: /reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384
-[luwra-push]: /reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa
+[luwra-push]: /reference/namespaceluwra.html#ab6cf73d2416b43f1a90eb243a98cff5b
 [luwra-membermap]: /reference/namespaceluwra.html#a2e12e40b973f0f56cb9a1dc91bef882a

+ 10 - 11
docs/output/advanced/index.html

@@ -74,7 +74,7 @@
         
             <ul>
             
-                <li class="toctree-l3"><a href="#operating-on-lua-values-with-c-functions">Operating on Lua values with C++ functions</a></li>
+                <li class="toctree-l3"><a href="#advanced-stack-interaction">Advanced stack interaction</a></li>
                 
                     <li><a class="toctree-l4" href="#invoke-a-callable-with-lua-values">Invoke a Callable with Lua values</a></li>
                 
@@ -136,13 +136,13 @@
           <div role="main">
             <div class="section">
               
-                <h1 id="operating-on-lua-values-with-c-functions">Operating on Lua values with C++ functions</h1>
+                <h1 id="advanced-stack-interaction">Advanced stack interaction</h1>
 <p>Instead of extracting every Lua value seperately and pushing the result of your C++ function back
-onto the stack again, you can use one of the following functions to make this process easier for you.</p>
+onto the stack again, you can use one of the following functions to make this process easier for
+you.</p>
 <h2 id="invoke-a-callable-with-lua-values">Invoke a Callable with Lua values</h2>
-<p>The function <a href="../reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a">direct&lt;S&gt;</a>
-lets you specify a <em>stack signature</em> in order to extract the values and invoke a <code>Callable</code> with
-them.</p>
+<p>The function <a href="../reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a">direct</a> lets you specify a <em>stack signature</em> in order to extract the
+values and invoke a <code>Callable</code> with them.</p>
 <p>Consider the following:</p>
 <pre><code class="c++">string result = foo(luwra::read&lt;string&gt;(lua, n), luwra::read&lt;int&gt;(lua, n + 1));
 </code></pre>
@@ -154,11 +154,10 @@ them.</p>
 <p><strong>Note:</strong> The result of <code>foo</code> is not pushed onto the stack. Except for the extraction of Lua values,
 everything happens on the C++ side.</p>
 <h2 id="invoke-a-function-with-lua-values">Invoke a function with Lua values</h2>
-<p><a href="../reference/namespaceluwra.html#a839077ddd9c3d0565a40c574bc8e9555">apply</a> is similiar to
-<a href="../reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a">direct</a>. The function <code>apply</code>
-provides specific overloads for function pointers and function objects. Although <code>direct</code> works
-with function pointers and function objects, it is often more convenient to use <code>apply</code> since it
-allows the compiler to infer the <em>stack signature</em> without providing a template parameter.</p>
+<p><a href="../reference/namespaceluwra.html#a839077ddd9c3d0565a40c574bc8e9555">apply</a> is similiar to <a href="../reference/namespaceluwra.html#aa20e363f38b3ae5a168cf40365f5646a">direct</a>. It differs from <code>direct</code> by providing
+specific overloads for function pointers and function objects. Although <code>direct</code> works with function pointers
+and function objects, it is often more convenient to use <code>apply</code> since it allows the compiler to
+infer the <em>stack signature</em> without providing a template parameter.</p>
 <p>Provided a function <code>foo</code> which has been declared as used in the example above:</p>
 <pre><code class="c++">string foo(string bar, int baz);
 

+ 1 - 1
docs/output/index.html

@@ -200,5 +200,5 @@ means that all functions and classes can operate on <a href="http://www.lua.org/
 
 <!--
 MkDocs version : 0.15.3
-Build Date UTC : 2016-05-21 15:22:08.371518
+Build Date UTC : 2016-05-21 18:56:55.799005
 -->

File diff suppressed because it is too large
+ 0 - 0
docs/output/mkdocs/search_index.json


+ 6 - 5
docs/output/stack-interaction/index.html

@@ -287,7 +287,7 @@ out of the box:</p>
 <td>function, table or userdata</td>
 </tr>
 <tr>
-<td><a href="../reference/structluwra_1_1NativeFunction_3_01R_07A_8_8_8_08_4.html">NativeFunction</a></td>
+<td><a href="../reference/structluwra_1_1NativeFunction.html">NativeFunction</a></td>
 <td>yes</td>
 <td>yes</td>
 <td>function</td>
@@ -324,8 +324,8 @@ type <code>T</code>.</p>
 </code></pre>
 
 <h2 id="pushing-c-values">Pushing C++ values</h2>
-<p>When pushing values onto the stack you can either use <a href="../reference/structluwra_1_1Value.html#aa376d68285606c206562b822e8187384">Value&lt;T&gt;::push</a> or
-the more convenient <a href="../reference/namespaceluwra.html#ae8e7eab11fc2cf3f258ffd81571066fa">push</a>.</p>
+<p>When pushing values onto the stack you can either use <code>Value&lt;T&gt;::push</code> or the more convenient
+<a href="../reference/namespaceluwra.html#ab6cf73d2416b43f1a90eb243a98cff5b">push</a>.</p>
 <pre><code class="c++">// Push an integer
 luwra::push(lua, 1338);
 
@@ -388,8 +388,9 @@ pushable type.</p>
 </tr>
 </tbody>
 </table>
-<p>It is possible to provide a template parameter to <code>push</code> to enforce pushing a specific type.
-In most cases you are probably better off by letting the compiler infer the template parameter.</p>
+<p>It is possible to provide a template parameter to <a href="../reference/namespaceluwra.html#ab6cf73d2416b43f1a90eb243a98cff5b">push</a> to enforce pushing a specific
+type. In most cases you are probably better off by letting the compiler infer the template
+parameter.</p>
 <h2 id="reading-lua-values">Reading Lua values</h2>
 <p>Simple retrieval of Lua values is done using <a href="../reference/namespaceluwra.html#a4fe4e574680cf54a0f8d958740eb90ab">read&lt;T&gt;</a>. Consider the stack layout
 from the previous example. This is how you would retrieve a value from the stack.</p>

Some files were not shown because too many files changed in this diff