From 0071f7439336a03006fb8a14dddd3a00c67ef713 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Wed, 9 Apr 2008 17:27:08 +0000 Subject: [PATCH] Rebuild the function types documentation. [SVN r44131] --- .../boost_functiontypes/about_tag_types.html | 23 +++-- .../boost_functiontypes/acknowledgements.html | 21 ++-- .../boost_functiontypes/introduction.html | 36 +++---- doc/html/boost_functiontypes/rationale.html | 91 ++++++++--------- doc/html/boost_functiontypes/reference.html | 24 +++-- .../reference/classification.html | 99 +++++++++---------- .../reference/decomposition.html | 58 +++++------ .../boost_functiontypes/reference/macros.html | 93 ++++++++--------- .../reference/synthesis.html | 66 ++++++------- .../reference/tag_types.html | 98 +++++++++--------- doc/html/boost_functiontypes/use_cases.html | 26 ++--- doc/html/index.html | 16 +-- 12 files changed, 336 insertions(+), 315 deletions(-) diff --git a/doc/html/boost_functiontypes/about_tag_types.html b/doc/html/boost_functiontypes/about_tag_types.html index d16c916..7d07a85 100644 --- a/doc/html/boost_functiontypes/about_tag_types.html +++ b/doc/html/boost_functiontypes/about_tag_types.html @@ -1,21 +1,21 @@ - About Tag Types +About Tag Types - + - - + + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -24,7 +24,8 @@

- About Tag Types

+ About Tag Types +

Boost.FunctionTypes uses tag types to encode properties that are not types per se, such as calling convention or whether a function is variadic or cv- @@ -84,7 +85,11 @@ - +
Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+ 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) +

+

diff --git a/doc/html/boost_functiontypes/acknowledgements.html b/doc/html/boost_functiontypes/acknowledgements.html index 414b34e..b0498b7 100644 --- a/doc/html/boost_functiontypes/acknowledgements.html +++ b/doc/html/boost_functiontypes/acknowledgements.html @@ -1,20 +1,20 @@ - Acknowledgements +Acknowledgements - + - + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -23,7 +23,8 @@

- Acknowledgements

+ Acknowledgements +

Thanks go to the following people for supporting the development of this library in one or the other way: @@ -78,7 +79,11 @@ - +
Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+ 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) +

+

diff --git a/doc/html/boost_functiontypes/introduction.html b/doc/html/boost_functiontypes/introduction.html index 8287622..cdaf6b1 100644 --- a/doc/html/boost_functiontypes/introduction.html +++ b/doc/html/boost_functiontypes/introduction.html @@ -1,21 +1,21 @@ - Introduction +Introduction - + - + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -24,7 +24,8 @@

- Introduction

+ Introduction +

Boost.FunctionTypes provides functionality to classify, decompose and synthesize function, function pointer, function reference and pointer to member types. @@ -56,35 +57,34 @@ constant called value. 

-is_function_pointer< bool(*)(int) >::value // == true 
+is_function_pointer< bool(*)(int) >::value // == true 
 
-function_arity< bool(*)(int) >::value // == 1
+function_arity< bool(*)(int) >::value // == 1

Templates that encapsulate properties that are single types contain a type member called type. 

-function_type< mpl::vector<bool,int> >::type // is bool(int)
+function_type< mpl::vector<bool,int> >::type // is bool(int)
 
-result_type< bool(&)(int) >::type // is bool
+result_type< bool(&)(int) >::type // is bool

Templates that encapsulate properties that are type lists model an MPL-compatible type sequence. 

-parameter_types< bool(int) > // models an MPL sequence
+parameter_types< bool(int) > // models an MPL sequence
- +
Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+ 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) +

+
diff --git a/doc/html/boost_functiontypes/rationale.html b/doc/html/boost_functiontypes/rationale.html index 475a795..5ba69d0 100644 --- a/doc/html/boost_functiontypes/rationale.html +++ b/doc/html/boost_functiontypes/rationale.html @@ -1,21 +1,21 @@ - Rationale +Rationale - + - - + + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -24,12 +24,13 @@

- Rationale

-

- - Error + Rationale +

+

+ + Error handling rationale -

+

The library does not define the required members of class templates in case of an error. This technique causes the compiler to stop displaying diagnostics @@ -40,10 +41,10 @@ The library's components have limited error conditions, so problematic input can be spotted easily.

-

- - Why MPL Sequences? -

+

+ + Why MPL Sequences? +

MPL provides algorithms on Sequences, so transformations (such as turning by-value parameter types into const references for optimized forwarding or computing @@ -53,20 +54,20 @@ other Boost libraries (most importantly Fusion), so another reason is interoperability.

-

- - Pointer +

+ + Pointer to member object types -

+

Despite their syntax, pointer to member object types can be seen as dereferencing functionals.

-

- - The +

+ + The ClassTransform template parameter -

+

This-pointer, this-reference or just the object (or maybe even a smart pointer to the object) plus adjustments of @@ -79,10 +80,10 @@ client to adjust the class type before the sequence is formed and then treat all parameters uniformly.

-

- - Why tag types? -

+

+ + Why tag types? +

Let's consider the alternatives.

@@ -98,12 +99,12 @@ parameters do not work within MPL lambda expressions and can cause problems with older compilers.

-

- - Is +

+ + Is it safe to have the synthesis templates take a callable builtin type or an MPL sequence as the first template argument? -

+

Yes, but it isn't immediately obvious as the set of possible MPL sequences isn't inherently disjoint from the set of callable builtin types. @@ -113,25 +114,23 @@ idea, because builtin types are accessible before the headers that make the type a sequence have been included, which can easily violate the ODR.

-

- - Why +

+ + Why does the hidden this parameter count for the function arity of member functions? -

+

It was found preferable that the following condition holds: 

-mpl::size< parameter_types<T> >::value == function_arity<T>::value
+mpl::size< parameter_types<T> >::value == function_arity<T>::value
-

- - Why +

+ + Why ignore top-level cv-qualifiers on pointers? -

+

A cv-qualified pointer is still a pointer. It usually doesn't matter and even if it does, it's a job for Boost.TypeTraits. @@ -139,7 +138,11 @@ - +
Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+ 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) +

+

diff --git a/doc/html/boost_functiontypes/reference.html b/doc/html/boost_functiontypes/reference.html index 91fe6f3..eacf2d4 100644 --- a/doc/html/boost_functiontypes/reference.html +++ b/doc/html/boost_functiontypes/reference.html @@ -1,22 +1,21 @@ - Reference +Reference - + - - + + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -25,7 +24,8 @@

- Reference

+ Reference +
Class templates for type classification
@@ -39,7 +39,11 @@
- +
Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+ 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) +

+
diff --git a/doc/html/boost_functiontypes/reference/classification.html b/doc/html/boost_functiontypes/reference/classification.html index 699dae9..2f49b79 100644 --- a/doc/html/boost_functiontypes/reference/classification.html +++ b/doc/html/boost_functiontypes/reference/classification.html @@ -1,23 +1,21 @@ - Class - templates for type classification +Class templates for type classification - + - - - + + + - + - - + +
Boost C++ LibrariesHomeHome LibrariesPeopleFAQPeopleFAQ More
@@ -26,9 +24,9 @@

- Class - templates for type classification

+ Class + templates for type classification +
is_function
@@ -49,12 +47,11 @@

- - is_function

+ + is_function +
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_function;

@@ -93,12 +90,11 @@

- - is_function_pointer

+ + is_function_pointer +
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_function_pointer;

@@ -137,12 +133,11 @@

- - is_function_reference

+ + is_function_reference +
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_function_reference;

@@ -181,12 +176,11 @@

- - is_member_pointer

+ + is_member_pointer +
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_member_pointer;

@@ -225,9 +219,9 @@

- - is_member_object_pointer

+ + is_member_object_pointer +
 template<typename T>
 struct is_member_object_pointer;
@@ -263,12 +257,11 @@
 
 

 

+
+        is_member_function_pointer
+

 
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_member_function_pointer;
 

 

@@ -307,12 +300,11 @@
 
 

 

+
+        is_callable_builtin
+

 
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_callable_builtin;
 

 

@@ -351,12 +343,11 @@
 
 

 

+
+        is_nonmember_callable_builtin
+

 
-template<typename T, typename Tag = null_tag>
+template<typename T, typename Tag = null_tag>
 struct is_nonmember_callable_builtin;
 

 

@@ -397,7 +388,11 @@
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/boost_functiontypes/reference/decomposition.html b/doc/html/boost_functiontypes/reference/decomposition.html
index bb1b431..b4447e4 100644
--- a/doc/html/boost_functiontypes/reference/decomposition.html
+++ b/doc/html/boost_functiontypes/reference/decomposition.html
@@ -1,24 +1,21 @@
 
 
 
- Class templates
-      for type decomposition
+Class templates for type decomposition
 
-
+
 
-
-
-
+
+
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -27,9 +24,9 @@
 

 

 

+ Class templates
+      for type decomposition
+

 

 

         result_type

@@ -42,9 +39,9 @@
 

 

 

+
+        result_type
+

 
 template<typename F>
 struct result_type;
@@ -78,9 +75,9 @@
 
 

 

+
+        parameter_types
+

 
 template<typename F, class ClassTransform = add_reference<_> >
 struct parameter_types;
@@ -124,9 +121,9 @@
 
 

 

+
+        function_arity
+

 
 template<typename F>
 struct function_arity;
@@ -169,9 +166,9 @@
 
 

 

+
+        components
+

 
 template<typename T, class ClassTransform = add_reference<_> >
 struct components;
@@ -216,14 +213,17 @@
         

 

           If T is no callable builtin type, the component types
-          are an empty sequence and the Tag's meaning is equivalent to the null_tag.
+          are an empty sequence and the Tag's meaning is equivalent to the null_tag.
         

 
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/boost_functiontypes/reference/macros.html b/doc/html/boost_functiontypes/reference/macros.html
index 48cfda6..ea3f1eb 100644
--- a/doc/html/boost_functiontypes/reference/macros.html
+++ b/doc/html/boost_functiontypes/reference/macros.html
@@ -1,21 +1,21 @@
 
 
 
- Macros
+Macros
 
-
+
 
-
-
-
+
+
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -24,7 +24,8 @@
 

 

 

+ Macros
+

 

 

         BOOST_FT_MAX_ARITY

@@ -47,9 +48,9 @@
 

 

 

+
+        BOOST_FT_MAX_ARITY
+

 

           Expands to a numeric value that describes the maximum function arity supported
           by the library.
@@ -66,17 +67,16 @@
       

 

 

+
+        BOOST_FT_CC_NAMES
+

 

           Expands to a sequence
           of ternary tuples
           (these data types are defined in the documentation
           of the Boost Preprocessor library). Each sequence element describes
           one calling convention specifier. The first element in each tuple is the
-          macro suffix for BOOST_FT_CC_*,
+          macro suffix for BOOST_FT_CC_*,
           the second element is the name of the tag that describes the calling convention
           and the third is the name of the specifier. The specifier is allowed to
           be an empty string, so the third tuple element is either BOOST_PP_EMPTY
@@ -106,15 +106,13 @@
 
 

 

+
+        BOOST_FT_CC_*
+

 

-          Enables a specific calling convention. * dentoes the macro suffix, as defined
-          by BOOST_FT_CC_NAMES
-          or BOOST_FT_BUILTIN_CC_NAMES.
+          Enables a specific calling convention. * denotes the macro suffix, as defined
+          by BOOST_FT_CC_NAMES
+          or BOOST_FT_BUILTIN_CC_NAMES.
         

 

           The macro expands to a list of restrictions, separated by the |
@@ -149,9 +147,9 @@
 
 

 

+
+        BOOST_FT_COMMON_X86_CCs
+

 

           Defining this macro causes the following macros to be defined, if not defined
           already:
@@ -164,9 +162,9 @@
 
 

 

+
+        BOOST_FT_SYNTAX
+

 

           This macro allows to change the syntax of callable builtin types. It is
           useful to handle the compiler specific placement of the calling convention
@@ -182,9 +180,9 @@
 
 

 

+
+        BOOST_FT_NULLARY_PARAM
+

 

           Set to void for compilers that insist on a void
           parameter for nullary function types, empty by default.
@@ -192,9 +190,9 @@
 
 

 

+
+        BOOST_FT_NO_CV_FUNC_SUPPORT
+

 

           Disables support for cv-qualified function types. Cv-qualified function
           types are illegal by the current standard version, but there is a pending
@@ -209,9 +207,9 @@
       

 

 

+
+        BOOST_FT_PREPROCESSING_MODE
+

 

           Makes the compiler preprocess as much as possible of the library code (rather
           than loading already-preprocessed header files) if defined.
@@ -219,24 +217,27 @@
 
 

 

+
+        BOOST_FT_CC_PREPROCESSING
+

 

           Makes the compiler preprocess the loop over possible names for custom calling
           conventions (rather than loading an already-preprocessed header file) if
           defined.
         

 

-          This macro is defined automatically if BOOST_FT_CC_NAMES
+          This macro is defined automatically if BOOST_FT_CC_NAMES
           has been defined.
         

 
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/boost_functiontypes/reference/synthesis.html b/doc/html/boost_functiontypes/reference/synthesis.html
index f1bed9f..fdf12ab 100644
--- a/doc/html/boost_functiontypes/reference/synthesis.html
+++ b/doc/html/boost_functiontypes/reference/synthesis.html
@@ -1,23 +1,21 @@
 
 
 
- Class templates
-      for type synthesis
+Class templates for type synthesis
 
-
+
 
-
-
-
+
+
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -26,9 +24,9 @@
 

 

 

+ Class templates
+      for type synthesis
+

 

 

         function_type

@@ -41,12 +39,11 @@
 

 

 

+
+        function_type
+

 
-template<typename Types, typename Tag = null_tag> 
+template<typename Types, typename Tag = null_tag> 
 struct function_type;
 

 

@@ -84,12 +81,11 @@
 
 

 

+
+        function_pointer
+

 
-template<typename Types, typename Tag = null_tag> 
+template<typename Types, typename Tag = null_tag> 
 struct function_pointer;
 

 

@@ -127,12 +123,11 @@
 
 

 

+
+        function_reference
+

 
-template<typename Types, typename Tag = null_tag> 
+template<typename Types, typename Tag = null_tag> 
 struct function_reference;
 

 

@@ -170,12 +165,11 @@
 
 

 

+
+        member_function_pointer
+

 
-template<typename Types, typename Tag = null_tag> 
+template<typename Types, typename Tag = null_tag> 
 struct member_function_pointer;
 

 

@@ -220,7 +214,11 @@
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/boost_functiontypes/reference/tag_types.html b/doc/html/boost_functiontypes/reference/tag_types.html
index 955296b..847d74f 100644
--- a/doc/html/boost_functiontypes/reference/tag_types.html
+++ b/doc/html/boost_functiontypes/reference/tag_types.html
@@ -1,22 +1,21 @@
 
 
 
- Tag Types
+Tag Types
 
-
+
 
-
-
-
+
+
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -25,7 +24,8 @@
 

 

 

+ Tag Types
+

 

 

         variadic

@@ -54,9 +54,9 @@
 

 

 

+
+        variadic
+

 
 typedef unspecified variadic;
 

@@ -73,9 +73,9 @@
 
 

 

+
+        non_variadic
+

 
 typedef unspecified non_variadic;
 

@@ -91,9 +91,9 @@
 
 

 

+
+        default_cc
+

 
 typedef unspecified default_cc;
 

@@ -109,9 +109,9 @@
 
 

 

+
+        const_qualified
+

 
 typedef unspecified const_qualified;
 

@@ -127,9 +127,9 @@
 
 

 

+
+        non_const
+

 
 typedef unspecified non_const;
 

@@ -145,9 +145,9 @@
 
 

 

+
+        volatile_qualified
+

 
 typedef unspecified volatile_qualified;
 

@@ -163,9 +163,9 @@
 
 

 

+
+        non_volatile
+

 
 typedef unspecified non_volatile;
 

@@ -181,7 +181,8 @@
 
 

 

+ non_cv
+

 
 typedef unspecified non_cv;
 

@@ -199,9 +200,9 @@
 
 

 

+
+        const_non_volatile
+

 
 typedef unspecified const_non_volatile;
 

@@ -219,9 +220,9 @@
 
 

 

+
+        volatile_non_const
+

 
 typedef unspecified volatile_non_const;
 

@@ -239,9 +240,9 @@
 
 

 

+
+        cv_qualfied
+

 
 typedef unspecified cv_qualified;
 

@@ -259,9 +260,9 @@
 
 

 

+
+        null_tag
+

 
 typedef unspecified null_tag;
 

@@ -277,7 +278,8 @@
 
 

 

+ tag
+

 
 template<class Tag1, class Tag2, 
     class Tag3 = null_tag, class Tag4 = null_tag>
@@ -310,7 +312,11 @@
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/boost_functiontypes/use_cases.html b/doc/html/boost_functiontypes/use_cases.html
index 803b994..8cee449 100644
--- a/doc/html/boost_functiontypes/use_cases.html
+++ b/doc/html/boost_functiontypes/use_cases.html
@@ -1,21 +1,21 @@
 
 
 
- Use Cases
+Use Cases
 
-
+
 
 
-
-
+
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -24,7 +24,8 @@
 

 

 

+ Use Cases
+

 

       Generic libraries that accept callable arguments are common in C++. Accepting
       a callable argument of builin type often involves a lot of repetitive code
@@ -143,8 +144,7 @@
       arguments from a type sequence in a single expression:
     

 
-static_cast<function_pointer<Seq>::type>(& overloaded)
+static_cast<function_pointer<Seq>::type>(& overloaded)
 

 

       This technique can be occasionally more flexible than template argument deduction
@@ -165,7 +165,11 @@
 
 
-
+

 Copyright © 2004 -2007 Tobias Schwinger
Copyright © 2004 -2007 Tobias Schwinger

+        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)
+      

+

 

 

 

diff --git a/doc/html/index.html b/doc/html/index.html
index 2f32aa2..c95f3f7 100644
--- a/doc/html/index.html
+++ b/doc/html/index.html
@@ -3,17 +3,17 @@
 
 Chapter 1. Boost.FunctionTypes 2.5
 
-
+
 
-
+
 
 
 
-
+
-
-
+
+

 Boost C++ LibrariesHomeHome
 LibrariesPeopleFAQPeopleFAQ
 More
 

 

@@ -27,7 +27,7 @@
 

 
Copyright © 2004 -2007 Tobias Schwinger

 

-

+

         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)
       

@@ -46,8 +46,8 @@
 

 

 
-
-
+
+
Last revised: November 05, 2007 at 18:24:58 +0100
Last revised: March 14, 2008 at 18:36:46 +0000

 

 

 
Next