Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r76816 - in sandbox/local_function/libs/functional/overloaded_function/doc/html: . boost boost_functional_overloadedfunction
From: lorcaminiti_at_[hidden]
Date: 2012-01-31 19:06:44

Author: lcaminiti
Date: 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
New Revision: 76816
URL: http://svn.boost.org/trac/boost/changeset/76816

Log:
Updated docs.
Added:
   sandbox/local_function/libs/functional/overloaded_function/doc/html/boost_functional_overloadedfunction/Acknowledgments.html (contents, props changed)
Text files modified:
   sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html | 2 +-
   sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html | 2 +-
   sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/make_overloaded_function.html | 2 +-
   sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/overloaded_function.html | 22 +++++++++++-----------
   sandbox/local_function/libs/functional/overloaded_function/doc/html/index.html | 2 +-
   5 files changed, 15 insertions(+), 15 deletions(-)

Modified: sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html
==============================================================================
--- sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html (original)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -33,7 +33,7 @@

BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX</pre></div>
<div class="refsect1">
-<a name="id834751"></a><h2>Description</h2>
+<a name="id843490"></a><h2>Description</h2>
If this macro is left undefined by the user, it has a default value of 5 (increasing this number might increase compilation time). When specified by the user, this macro must be a non-negative integer number.
See: <a class="link" href="boost_functional_overloadedfunction/Getting_Started.html" title="Getting Started"> Getting Started</a>, <code class="computeroutput"><a class="link" href="boost/overloaded_function.html" title="Class template overloaded_function">boost::overloaded_function</a></code>. 
</div>

Modified: sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html
==============================================================================
--- sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html (original)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -33,7 +33,7 @@

BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX</pre></div>
<div class="refsect1">
-<a name="id834809"></a><h2>Description</h2>
+<a name="id843547"></a><h2>Description</h2>
If this macro is left undefined by the user, it has a default value of 5 (increasing this number might increase compilation time). When defined by the user, this macro must be an integer number greater or equal than 2 (because at least two distinct functions need to be specified in order to define an overload).
See: <a class="link" href="boost_functional_overloadedfunction/Getting_Started.html" title="Getting Started"> Getting Started</a>, <code class="computeroutput"><a class="link" href="boost/overloaded_function.html" title="Class template overloaded_function">boost::overloaded_function</a></code>. 
</div>

Modified: sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/make_overloaded_function.html
==============================================================================
--- sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/make_overloaded_function.html (original)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/make_overloaded_function.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -36,7 +36,7 @@
<a class="link" href="overloaded_function.html" title="Class template overloaded_function">overloaded_function</a>< __function_type__< F1 >, __function_type__< F2 >,...>
make_overloaded_function(F1 f1, F2 f2, ...);</pre></div>
<div class="refsect1">
-<a name="id834570"></a><h2>Description</h2>
+<a name="id843308"></a><h2>Description</h2>
This function template creates and returns an <code class="computeroutput"><code class="computeroutput"><a class="link" href="overloaded_function.html" title="Class template overloaded_function">overloaded_function</a></code></code> function object that overloads all the specified functions <code class="computeroutput">f1</code>, <code class="computeroutput">f2</code>, etc.
The function types are internally determined from the template parameter types so they do not need to be explicitly specified. Therefore, this function template usually has a more concise syntax when compared with <code class="computeroutput"><code class="computeroutput"><a class="link" href="overloaded_function.html" title="Class template overloaded_function">overloaded_function</a></code></code>. This is especially useful when the explicit type of the returned <code class="computeroutput"><code class="computeroutput"><a class="link" href="overloaded_function.html" title="Class template overloaded_function">overloaded_function</a></code></code> does not need to be known (e.g., when used with Boost.Typeof's <code class="computeroutput">BOOST_AUTO</code> (or C++11 <code class="computeroutput">auto</code>) or when the overloaded function object is handled using a function template parameter, see the <a class="link" href="../boost_functional_overloadedfunction/Tutorial.html" title="Tutorial">Tutorial</a>
section).
The maximum number of functions to overload is given by the <code class="computeroutput"><code class="computeroutput"><a class="link" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX">BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX</a></code></code> configuration macro.

Modified: sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/overloaded_function.html
==============================================================================
--- sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/overloaded_function.html (original)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/boost/overloaded_function.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -35,19 +35,19 @@
class <a class="link" href="overloaded_function.html" title="Class template overloaded_function">overloaded_function</a> {
public:
 // <a class="link" href="overloaded_function.html#boost.overloaded_functionconstruct-copy-destruct">construct/copy/destruct</a>
- <a class="link" href="overloaded_function.html#id237883-bb">overloaded_function</a>(const boost::function< F1 > &,
+ <a class="link" href="overloaded_function.html#id265190-bb">overloaded_function</a>(const boost::function< F1 > &,
 const boost::function< F2 > &, ...);

- // <a class="link" href="overloaded_function.html#id237814-bb">public member functions</a>
+ // <a class="link" href="overloaded_function.html#id265120-bb">public member functions</a>
 boost::function_traits< F1 >::result_type
- <a class="link" href="overloaded_function.html#id237816-bb">operator()</a>(typename boost::function_traits< F1 >::arg1_type,
+ <a class="link" href="overloaded_function.html#id265123-bb">operator()</a>(typename boost::function_traits< F1 >::arg1_type,
 typename boost::function_traits< F1 >::arg2_type, ...) const;
 boost::function_traits< F2 >::result_type
- <a class="link" href="overloaded_function.html#id237843-bb">operator()</a>(typename boost::function_traits< F2 >::arg1_type,
+ <a class="link" href="overloaded_function.html#id265149-bb">operator()</a>(typename boost::function_traits< F2 >::arg1_type,
 typename boost::function_traits< F2 >::arg2_type, ...) const;
};</pre></div>
<div class="refsect1">
-<a name="id833824"></a><h2>Description</h2>
+<a name="id842562"></a><h2>Description</h2>
This function object aggregates together calls to functions of all the specified function types <code class="computeroutput">F1</code>, <code class="computeroutput">F2</code>, etc. The specified function types must have distinct parameters from one another and they must be in the following format (which is the Boost.Function preferred syntax): 
<pre class="programlisting"> result_type (argument1_type, argumgnet2_type, ...)
</pre>
@@ -55,27 +55,27 @@
The maximum number of functions to overload is given by the <code class="computeroutput"><a class="link" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX">BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX</a></code> configuration macro. The maximum number of function parameters for each of the specified function types is given by the <code class="computeroutput"><a class="link" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX">BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX</a></code> configuration macro.
See: <a class="link" href="../boost_functional_overloadedfunction/Tutorial.html" title="Tutorial">Tutorial</a> section, <code class="computeroutput"><a class="link" href="make_overloaded_function.html" title="Function template make_overloaded_function">make_overloaded_function</a></code>, <code class="computeroutput"><a class="link" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX">BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX</a></code>, <code class="computeroutput"><a class="link" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX">BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_ARITY_MAX</a></code>, Boost.Function. 
<div class="refsect2">
-<a name="id833944"></a><h3>
+<a name="id842682"></a><h3>
<a name="boost.overloaded_functionconstruct-copy-destruct"></a><code class="computeroutput">overloaded_function</code>
 public
 construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
-<pre class="literallayout"><a name="id237883-bb"></a>overloaded_function(const boost::function< F1 > &,
+<pre class="literallayout"><a name="id265190-bb"></a>overloaded_function(const boost::function< F1 > &,
 const boost::function< F2 > &, ...);</pre>Construct the overloaded function object. Any function pointer, function reference, and monomorphic function object that can be converted to a <code class="computeroutput">boost::function</code> function object can be specified as parameter. 
</li></ol></div>
</div>
<div class="refsect2">
-<a name="id834069"></a><h3>
-<a name="id237814-bb"></a><code class="computeroutput">overloaded_function</code> public member functions</h3>
+<a name="id842807"></a><h3>
+<a name="id265120-bb"></a><code class="computeroutput">overloaded_function</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout">boost::function_traits< F1 >::result_type
-<a name="id237816-bb"></a>operator()(typename boost::function_traits< F1 >::arg1_type,
+<a name="id265123-bb"></a>operator()(typename boost::function_traits< F1 >::arg1_type,
 typename boost::function_traits< F1 >::arg2_type, ...) const;</pre>Call operator matching the signature of the function type specified as 1st template parameter. This will in turn invoke the call operator of the 1st function passed to the constructor. 
</li>
<li class="listitem">
<pre class="literallayout">boost::function_traits< F2 >::result_type
-<a name="id237843-bb"></a>operator()(typename boost::function_traits< F2 >::arg1_type,
+<a name="id265149-bb"></a>operator()(typename boost::function_traits< F2 >::arg1_type,
 typename boost::function_traits< F2 >::arg2_type, ...) const;</pre>Call operator matching the signature of the function type specified as 2nd template parameter. This will in turn invoke the call operator of the 2nd function passed to the constructor.
Note: Similar call operators are present for all specified function types <code class="computeroutput">F1</code>, <code class="computeroutput">F2</code>, etc (even if not exhaustively listed by this documentation). 
</li>

Added: sandbox/local_function/libs/functional/overloaded_function/doc/html/boost_functional_overloadedfunction/Acknowledgments.html
==============================================================================
--- (empty file)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/boost_functional_overloadedfunction/Acknowledgments.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -0,0 +1,59 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
+<title>Acknowledgments</title>
+<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
+<link rel="home" href="../index.html" title="Chapter 1. Boost.Functional/OverloadedFunction 1.0.0">
+<link rel="up" href="../index.html" title="Chapter 1. Boost.Functional/OverloadedFunction 1.0.0">
+<link rel="prev" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html" title="Macro BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%"><tr>
+<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
+<td align="center">Home</td>
+<td align="center">Libraries</td>
+<td align="center">People</td>
+<td align="center">FAQ</td>
+<td align="center">More</td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+<div class="section">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boost_functional_overloadedfunction.Acknowledgments"></a><a class="link" href="Acknowledgments.html" title="Acknowledgments">Acknowledgments</a>
+</h2></div></div></div>
+
+ Many thanks to Mathias Gaunard for suggesting to implement <code class="computeroutput"><a class="link" href="../boost/overloaded_function.html" title="Class template overloaded_function">boost::overloaded_function</a></code>
+ and for some sample code.
+ 
+
+ Thanks to John Bytheway for suggesting to implement <code class="computeroutput"><a class="link" href="../boost/make_overloaded_function.html" title="Function template make_overloaded_function">boost::make_overloaded_function</a></code>.
+ 
+
+ Thanks to Nathan Ridge for suggestions on how to implement <code class="computeroutput"><a class="link" href="../boost/make_overloaded_function.html" title="Function template make_overloaded_function">boost::make_overloaded_function</a></code>.
+ 
+
+ Thanks to Robert Stewart for commenting on the library name.
+ 
+
+ Many thanks to the entire Boost community and mailing list for providing valuable
+ comments about this library and great insights on the C++ programming language.
+ 
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><div class="copyright-footer">Copyright © 2011, 2012 Lorenzo Caminiti
+ Distributed under the Boost Software License, Version 1.0 (see accompanying
+ file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+ 
+</div></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../BOOST_FUNCTIONAL_OVERLOADED_FUNCTION_CONFIG_OVERLOAD_MAX.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a>
+</div>
+</body>
+</html>

Modified: sandbox/local_function/libs/functional/overloaded_function/doc/html/index.html
==============================================================================
--- sandbox/local_function/libs/functional/overloaded_function/doc/html/index.html (original)
+++ sandbox/local_function/libs/functional/overloaded_function/doc/html/index.html 2012-01-31 19:06:42 EST (Tue, 31 Jan 2012)
@@ -133,7 +133,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: February 01, 2012 at 00:00:04 GMT</td>
+<td align="left">Last revised: February 01, 2012 at 00:05:54 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk