summaryrefslogtreecommitdiff
path: root/libs/python/doc
diff options
context:
space:
mode:
authorAnas Nashif <anas.nashif@intel.com>2013-08-26 08:15:55 -0400
committerAnas Nashif <anas.nashif@intel.com>2013-08-26 08:15:55 -0400
commitbb4dd8289b351fae6b55e303f189127a394a1edd (patch)
tree77c9c35a31b1459dd7988c2448e797d142530c41 /libs/python/doc
parent1a78a62555be32868418fe52f8e330c9d0f95d5a (diff)
downloadboost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.gz
boost-bb4dd8289b351fae6b55e303f189127a394a1edd.tar.bz2
boost-bb4dd8289b351fae6b55e303f189127a394a1edd.zip
Imported Upstream version 1.51.0upstream/1.51.0
Diffstat (limited to 'libs/python/doc')
-rw-r--r--libs/python/doc/tutorial/doc/html/python/functions.html4
-rw-r--r--libs/python/doc/tutorial/doc/tutorial.qbk4
-rw-r--r--libs/python/doc/v2/make_function.html51
3 files changed, 28 insertions, 31 deletions
diff --git a/libs/python/doc/tutorial/doc/html/python/functions.html b/libs/python/doc/tutorial/doc/html/python/functions.html
index ca869d1837..ddd5bc7b70 100644
--- a/libs/python/doc/tutorial/doc/html/python/functions.html
+++ b/libs/python/doc/tutorial/doc/html/python/functions.html
@@ -372,8 +372,8 @@ Namespaces are one honking great idea -- let's do more of those!
or writing thin wrappers:
</p>
<pre class="programlisting"><span class="comment">// write "thin wrappers"</span>
-<span class="keyword">int</span> <span class="identifier">f1</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">{</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">x</span><span class="special">);</span> <span class="special">}</span>
-<span class="keyword">int</span> <span class="identifier">f2</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">,</span> <span class="keyword">double</span> <span class="identifier">y</span><span class="special">)</span> <span class="special">{</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">);</span> <span class="special">}</span>
+<span class="keyword">int</span> <span class="identifier">f1</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">x</span><span class="special">);</span> <span class="special">}</span>
+<span class="keyword">int</span> <span class="identifier">f2</span><span class="special">(</span><span class="keyword">int</span> <span class="identifier">x</span><span class="special">,</span> <span class="keyword">double</span> <span class="identifier">y</span><span class="special">)</span> <span class="special">{</span> <span class="keyword">return</span> <span class="identifier">f</span><span class="special">(</span><span class="identifier">x</span><span class="special">,</span><span class="identifier">y</span><span class="special">);</span> <span class="special">}</span>
<span class="comment">/*...*/</span>
diff --git a/libs/python/doc/tutorial/doc/tutorial.qbk b/libs/python/doc/tutorial/doc/tutorial.qbk
index 204c500449..10a452200c 100644
--- a/libs/python/doc/tutorial/doc/tutorial.qbk
+++ b/libs/python/doc/tutorial/doc/tutorial.qbk
@@ -901,8 +901,8 @@ wrapping as outlined in the [link python.overloading previous section], or
writing thin wrappers:
// write "thin wrappers"
- int f1(int x) { f(x); }
- int f2(int x, double y) { f(x,y); }
+ int f1(int x) { return f(x); }
+ int f2(int x, double y) { return f(x,y); }
/*...*/
diff --git a/libs/python/doc/v2/make_function.html b/libs/python/doc/v2/make_function.html
index 3913672195..d5a6cdb06e 100644
--- a/libs/python/doc/v2/make_function.html
+++ b/libs/python/doc/v2/make_function.html
@@ -96,10 +96,10 @@ template &lt;class F, class Policies, class Keywords, class Signature&gt;
to <code>f</code>. <ul>
<li> If <code>policies</code> are supplied, it
will be applied to the function as described <a href=
- "CallPolicies.html">here</a>.
+ "CallPolicies.html">here</a>.
<li>If <code>keywords</code> are
supplied, the keywords will be applied in order to the final
- arguments of the resulting function.
+ arguments of the resulting function.
<li>If <code>Signature</code>
is supplied, it should be an instance of an <a
href="../../../mpl/doc/refmanual/front-extensible-sequence.html">MPL front-extensible
@@ -125,36 +125,33 @@ template &lt;class F, class Policies, class Keywords, class Signature&gt;
</dl>
<pre>
-<a name=
-"make_constructor-spec"></a>template &lt;class T, class ArgList, class Generator&gt;
-<a href="object.html#object-spec">object</a> make_constructor();
-
-template &lt;class ArgList, class Generator, class Policies&gt;
+<a name="make_constructor-spec">template &lt;class F&gt;</a>
+<a href="object.html#object-spec">object</a> make_constructor(F f)
+
+template &lt;class F, class Policies&gt;
+<a href=
+"object.html#object-spec">object</a> make_constructor(F f, Policies const&amp; policies)
+
+template &lt;class F, class Policies, class KeywordsOrSignature&gt;
+<a href=
+"object.html#object-spec">object</a> make_constructor(F f, Policies const&amp; policies, KeywordsOrSignature const&amp; ks)
+
+template &lt;class F, class Policies, class Keywords, class Signature&gt;
<a href=
-"object.html#object-spec">object</a> make_constructor(Policies const&amp; policies)
+"object.html#object-spec">object</a> make_constructor(F f, Policies const&amp; policies, Keywords const&amp; kw, Signature const&amp; sig)
</pre>
<dl class="function-semantics">
- <dt><b>Requires:</b> <code>T</code> is a class type.
- <code>Policies</code> is a model of <a href=
- "CallPolicies.html">CallPolicies</a>. <code>ArgList</code> is an <a
- href="../../../mpl/doc/refmanual/forward-sequence.html">MPL sequence</a> of C++ argument
- types (<i>A1,&nbsp;A2,...&nbsp;AN</i>) such that if
- <code>a1,&nbsp;a2</code>...&nbsp;<code>aN</code> are objects of type
- <i>A1,&nbsp;A2,...&nbsp;AN</i> respectively, the expression <code>new
- Generator::apply&lt;T&gt;::type(a1,&nbsp;a2</code>...&nbsp;<code>aN</code>)
- is valid. Generator is a model of <a href=
- "HolderGenerator.html">HolderGenerator</a>.</dt>
+ <dt><b>Requires:</b> <code>F</code> is a
+ function pointer type. If <code>policies</code> are supplied, it must
+ be a model of <a href="CallPolicies.html">CallPolicies</a>. If
+ <code>kewords</code> are supplied, it must be the result of a <a href=
+ "args.html#keyword-expression"><em>keyword-expression</em></a>
+ specifying no more arguments than the <a href=
+ "definitions.html#arity">arity</a> of <code>f</code>.</dt>
<dt><b>Effects:</b> Creates a Python callable object which, when called
- from Python, expects its first argument to be a Boost.Python extension
- class object. It converts its remaining its arguments to C++ and passes
- them to the constructor of a dynamically-allocated
- <code>Generator::apply&lt;T&gt;::type</code> object, which is then
- installed in the extension class object. In the second form, the
- <code>policies</code> are applied to the arguments and result (<a href=
- "http://www.python.org/doc/current/lib/bltin-null-object.html">None</a>)
- of the Python callable object</dt>
+ from Python, converts its arguments to C++ and calls <code>f</code>.</dt>
<dt><b>Returns:</b> An instance of <a href=
"object.html#object-spec">object</a> which holds the new Python
@@ -186,7 +183,7 @@ BOOST_PYTHON_MODULE(make_function_test)
def("choose_function", choose_function);
}
</pre>
- It can be used this way in Python:
+ It can be used this way in Python:
<pre>
&gt;&gt;&gt; from make_function_test import *
&gt;&gt;&gt; f = choose_function(1)