|
From: Arvid N. <ar...@us...> - 2005-10-26 09:44:32
|
Update of /cvsroot/luabind/luabind/luabind/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2517 Modified Files: Tag: beta7-devel2 docs.html docs.rst Log Message: updated documentation Index: docs.html =================================================================== RCS file: /cvsroot/luabind/luabind/luabind/doc/docs.html,v retrieving revision 1.52.2.9 retrieving revision 1.52.2.10 diff -u -d -r1.52.2.9 -r1.52.2.10 --- docs.html 24 Oct 2005 23:11:46 -0000 1.52.2.9 +++ docs.html 26 Oct 2005 09:44:23 -0000 1.52.2.10 @@ -24,7 +24,7 @@ <tr><th class="docinfo-name">Date:</th> <td>2005-10-24</td></tr> <tr><th class="docinfo-name">Revision:</th> -<td>1.25.2.10</td></tr> +<td>1.25.2.11</td></tr> <tr class="field"><th class="docinfo-name">License:</th><td class="field-body"><p class="first">Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation @@ -1010,6 +1010,8 @@ <p>Here, the class <tt class="docutils literal"><span class="pre">X</span></tt> is registered in two steps. The two functions <tt class="docutils literal"><span class="pre">register_part1</span></tt> and <tt class="docutils literal"><span class="pre">register_part2</span></tt> may be put in separate compilation units.</p> +<p>To separate the module registration and the classes to be registered, see +<a class="reference" href="#splitting-up-the-registration">Splitting up the registration</a>.</p> </div> </div> <div class="section" id="object"> @@ -1666,7 +1668,7 @@ </ul> </div> <div class="section" id="adopt"> -<h2><a name="adopt">12.1 adopt</a></h2> +<h2><a class="toc-backref" href="#id93" name="adopt">12.1 adopt</a></h2> <div class="section" id="motivation"> <h3><a name="motivation">12.1.1 Motivation</a></h3> <p>Used to transfer ownership across language boundaries.</p> @@ -1720,7 +1722,7 @@ </div> </div> <div class="section" id="dependency"> -<h2><a name="dependency">12.2 dependency</a></h2> +<h2><a class="toc-backref" href="#id94" name="dependency">12.2 dependency</a></h2> <div class="section" id="id2"> <h3><a name="id2">12.2.1 Motivation</a></h3> <p>The dependency policy is used to create life-time dependencies between values. @@ -1778,7 +1780,7 @@ </div> </div> <div class="section" id="out-value"> -<h2><a name="out-value">12.3 out_value</a></h2> +<h2><a class="toc-backref" href="#id95" name="out-value">12.3 out_value</a></h2> <div class="section" id="id7"> <h3><a name="id7">12.3.1 Motivation</a></h3> <p>This policy makes it possible to wrap functions that take non-const references @@ -1841,7 +1843,7 @@ </div> </div> <div class="section" id="pure-out-value"> -<h2><a name="pure-out-value">12.4 pure_out_value</a></h2> +<h2><a class="toc-backref" href="#id96" name="pure-out-value">12.4 pure_out_value</a></h2> <div class="section" id="id12"> <h3><a name="id12">12.4.1 Motivation</a></h3> <p>This works exactly like <tt class="docutils literal"><span class="pre">out_value</span></tt>, except that it will pass a @@ -1903,7 +1905,7 @@ </div> </div> <div class="section" id="return-reference-to"> -<h2><a name="return-reference-to">12.5 return_reference_to</a></h2> +<h2><a class="toc-backref" href="#id97" name="return-reference-to">12.5 return_reference_to</a></h2> <div class="section" id="id17"> <h3><a name="id17">12.5.1 Motivation</a></h3> <p>It is very common to return references to arguments or the this-pointer to @@ -1987,7 +1989,7 @@ </div> </div> <div class="section" id="copy"> -<h2><a name="copy">12.6 copy</a></h2> +<h2><a class="toc-backref" href="#id98" name="copy">12.6 copy</a></h2> <div class="section" id="id22"> <h3><a name="id22">12.6.1 Motivation</a></h3> <p>This will make a copy of the parameter. This is the default behavior when @@ -2046,7 +2048,7 @@ </div> </div> <div class="section" id="discard-result"> -<h2><a name="discard-result">12.7 discard_result</a></h2> +<h2><a class="toc-backref" href="#id99" name="discard-result">12.7 discard_result</a></h2> <div class="section" id="id27"> <h3><a name="id27">12.7.1 Motivation</a></h3> <p>This is a very simple policy which makes it possible to throw away @@ -2088,7 +2090,7 @@ </div> </div> <div class="section" id="return-stl-iterator"> -<h2><a name="return-stl-iterator">12.8 return_stl_iterator</a></h2> +<h2><a class="toc-backref" href="#id100" name="return-stl-iterator">12.8 return_stl_iterator</a></h2> <div class="section" id="id31"> <h3><a name="id31">12.8.1 Motivation</a></h3> <p>This policy converts an STL container to a generator function that can be used @@ -2133,7 +2135,7 @@ </div> </div> <div class="section" id="raw"> -<h2><a name="raw">12.9 raw</a></h2> +<h2><a class="toc-backref" href="#id101" name="raw">12.9 raw</a></h2> <div class="section" id="id35"> <h3><a name="id35">12.9.1 Motivation</a></h3> <p>This converter policy will pass through the <tt class="docutils literal"><span class="pre">lua_State*</span></tt> unmodified. @@ -2193,7 +2195,7 @@ </div> </div> <div class="section" id="yield"> -<h2><a name="yield">12.10 yield</a></h2> +<h2><a class="toc-backref" href="#id102" name="yield">12.10 yield</a></h2> <div class="section" id="id40"> <h3><a name="id40">12.10.1 Motivation</a></h3> <p>Makes a C++ function yield when returning.</p> @@ -2619,8 +2621,8 @@ <h1><a name="configuration">14 Configuration</a></h1> <p>As mentioned in the <a class="reference" href="http://www.lua.org/manual/5.0/manual.html">Lua documentation</a>, it is possible to pass an error handler function to <tt class="docutils literal"><span class="pre">lua_pcall()</span></tt>. Luabind makes use of -<tt class="docutils literal"><span class="pre">lua_pcall()</span></tt> internally when calling methods and functions. It is -possible to set the error handler function that Luabind will use +<tt class="docutils literal"><span class="pre">lua_pcall()</span></tt> internally when calling member functions and free functions. +It is possible to set the error handler function that Luabind will use globally:</p> <pre class="literal-block"> typedef void(*pcall_callback_fun)(lua_State*); @@ -2769,8 +2771,8 @@ the attribute '<em>class-name.attribute-name</em>' is read only </pre> <p>There is no data member named <em>attribute-name</em> in the class <em>class-name</em>, -or there's no setter-method registered on that property name. See the -properties section.</p> +or there's no setter-function registered on that property name. See the +<a class="reference" href="#properties">Properties</a> section.</p> </li> <li><pre class="first literal-block"> the attribute '<em>class-name.attribute-name</em>' is of type: (<em>class-name</em>) and does not match (<em>class_name</em>) @@ -2829,7 +2831,8 @@ <dt>Internal structure overflow in VC</dt> <dd>If you, in visual studio, get fatal error C1204: compiler limit : internal structure overflow. You should try to split that compilation -unit up in smaller ones.</dd> +unit up in smaller ones. See <a class="reference" href="#splitting-up-the-registration">Splitting up the registration</a> and +<a class="reference" href="#splitting-class-registrations">Splitting class registrations</a>.</dd> </dl> <!-- the three entries above were removed, why? --> <dl class="docutils"> @@ -2886,7 +2889,7 @@ in general).</p> </dd> </dl> -<!-- And again, the above is irrelevant to docs. This isn't a general C++ FAQ. --> +<!-- And again, the above is irrelevant to docs. This isn't a general C++ FAQ. But it saves us support questions. --> <dl class="docutils"> <dt>Fatal Error C1063 compiler limit : compiler stack overflow in VC</dt> <dd>VC6.5 chokes on warnings, if you are getting alot of warnings from your Index: docs.rst =================================================================== RCS file: /cvsroot/luabind/luabind/luabind/doc/docs.rst,v retrieving revision 1.25.2.11 retrieving revision 1.25.2.12 diff -u -d -r1.25.2.11 -r1.25.2.12 --- docs.rst 24 Oct 2005 23:11:46 -0000 1.25.2.11 +++ docs.rst 26 Oct 2005 09:44:23 -0000 1.25.2.12 @@ -36,6 +36,7 @@ .. contents:: :depth: 2 + :backlinks: none .. section-numbering:: Introduction @@ -990,6 +991,8 @@ ``register_part1`` and ``register_part2`` may be put in separate compilation units. +To separate the module registration and the classes to be registered, see +`Splitting up the registration`_. Object ====== @@ -2113,8 +2116,8 @@ As mentioned in the `Lua documentation`_, it is possible to pass an error handler function to ``lua_pcall()``. Luabind makes use of -``lua_pcall()`` internally when calling methods and functions. It is -possible to set the error handler function that Luabind will use +``lua_pcall()`` internally when calling member functions and free functions. +It is possible to set the error handler function that Luabind will use globally:: typedef void(*pcall_callback_fun)(lua_State*); @@ -2283,8 +2286,8 @@ the attribute '*class-name.attribute-name*' is read only There is no data member named *attribute-name* in the class *class-name*, - or there's no setter-method registered on that property name. See the - properties section. + or there's no setter-function registered on that property name. See the + Properties_ section. - .. parsed-literal:: @@ -2349,7 +2352,8 @@ Internal structure overflow in VC If you, in visual studio, get fatal error C1204: compiler limit : internal structure overflow. You should try to split that compilation - unit up in smaller ones. + unit up in smaller ones. See `Splitting up the registration`_ and + `Splitting class registrations`_. .. the three entries above were removed, why? @@ -2407,7 +2411,7 @@ you want to be sure that the correct destructor is called (this apply to C++ in general). -.. And again, the above is irrelevant to docs. This isn't a general C++ FAQ. +.. And again, the above is irrelevant to docs. This isn't a general C++ FAQ. But it saves us support questions. Fatal Error C1063 compiler limit \: compiler stack overflow in VC VC6.5 chokes on warnings, if you are getting alot of warnings from your |
