From 74d5955a7af929c9b860116a78ee7825909ec561 Mon Sep 17 00:00:00 2001 From: John Maddock Date: Wed, 13 Apr 2011 11:02:44 +0000 Subject: [PATCH] Fix misc typos and regenerate docs. Fixes #5457. Fixes #5458. Fixes #5459. Fixes #5460. Fixes #5461. [SVN r71222] --- doc/common_type.qbk | 2 +- doc/conditional.qbk | 2 +- doc/html/boost_typetraits/background.html | 16 ++++++++-------- .../boost_typetraits/category/transform.html | 2 +- doc/html/boost_typetraits/history.html | 8 ++++---- .../reference/common_type.html | 18 ++++++++++-------- .../reference/conditional.html | 4 +++- .../reference/is_convertible.html | 2 +- .../reference/is_stateless.html | 2 +- .../reference/is_virtual_base_of.html | 8 +++++++- doc/html/index.html | 2 +- doc/html/index/s11.html | 2 +- doc/html/index/s12.html | 2 +- doc/html/index/s13.html | 2 +- doc/html/index/s14.html | 2 +- doc/is_convertible.qbk | 2 +- doc/is_stateless.qbk | 2 +- doc/is_virtual_base_of.qbk | 5 ++++- 18 files changed, 48 insertions(+), 35 deletions(-) diff --git a/doc/common_type.qbk b/doc/common_type.qbk index cc7cf21..1d31ec1 100644 --- a/doc/common_type.qbk +++ b/doc/common_type.qbk @@ -14,7 +14,7 @@ [def __declval [@../../../utility/doc/html/declval.html declval]] -`#include ` +__header ` #include ` or ` #include ` namespace boost { template struct __common_type; diff --git a/doc/conditional.qbk b/doc/conditional.qbk index af72844..a4b867e 100644 --- a/doc/conditional.qbk +++ b/doc/conditional.qbk @@ -10,7 +10,7 @@ [/===================================================================] -`#include ` +__header ` #include ` or ` #include ` namespace boost { template struct __conditional; diff --git a/doc/html/boost_typetraits/background.html b/doc/html/boost_typetraits/background.html index bbd7870..97ac3a8 100644 --- a/doc/html/boost_typetraits/background.html +++ b/doc/html/boost_typetraits/background.html @@ -56,7 +56,7 @@ method available to them.

- + Type Traits

@@ -84,7 +84,7 @@ given.

- + Implementation

@@ -174,7 +174,7 @@ in the default template.

- + Optimized copy

@@ -247,7 +247,7 @@ otherwise it will call the "slow but safe version".

- + Was it worth it?

@@ -379,7 +379,7 @@

- + Pair of References

@@ -597,7 +597,7 @@ easier to maintain and easier to understand.

- + Conclusion

@@ -610,7 +610,7 @@ can be optimal as well as generic.

- + Acknowledgements

@@ -618,7 +618,7 @@ comments when preparing this article.

- + References
    diff --git a/doc/html/boost_typetraits/category/transform.html b/doc/html/boost_typetraits/category/transform.html index abb39ac..b32c4fe 100644 --- a/doc/html/boost_typetraits/category/transform.html +++ b/doc/html/boost_typetraits/category/transform.html @@ -103,7 +103,7 @@ struct remove_volatile;
    - + Broken Compiler Workarounds:
    diff --git a/doc/html/boost_typetraits/history.html b/doc/html/boost_typetraits/history.html index 96b3a3c..0f4d1f7 100644 --- a/doc/html/boost_typetraits/history.html +++ b/doc/html/boost_typetraits/history.html @@ -27,7 +27,7 @@ History
- + Boost 1.47.0
    @@ -41,7 +41,7 @@
- + Boost 1.45.0
    @@ -57,7 +57,7 @@
- + Boost 1.44.0
    @@ -73,7 +73,7 @@
- + Boost 1.42.0
  • diff --git a/doc/html/boost_typetraits/reference/common_type.html b/doc/html/boost_typetraits/reference/common_type.html index 4af6fd2..a65cbd6 100644 --- a/doc/html/boost_typetraits/reference/common_type.html +++ b/doc/html/boost_typetraits/reference/common_type.html @@ -27,7 +27,9 @@ common_type

- #include <boost/type_traits/common_type.hpp> + Header: #include + <boost/type_traits/common_type.hpp> + or #include <boost/type_traits.hpp>

namespace boost {
   template <class ...T>  struct common_type;
@@ -73,7 +75,7 @@
         template arguments is 3.
       

- + Configuration macros
@@ -103,7 +105,7 @@ Otherwise when BOOST_COMMON_TYPE_DONT_USE_TYPEOF is not defined it uses Boost.TypeOf.

- + Tutorial

@@ -138,7 +140,7 @@ This is a very useful and broadly applicable utility.

- + How to get the common type of types with explicit conversions?
@@ -160,7 +162,7 @@ };
- + How important is the order of the common_type<> template arguments?
@@ -240,7 +242,7 @@ A>.

- + Can the common_type of two types be a third type?
@@ -267,7 +269,7 @@ B>.

- + How common_type behaves with pointers?
@@ -303,7 +305,7 @@ Of course the user can always make this specialization.

- + Can you explain the pros/cons of common_type against Boost.Typeof?
diff --git a/doc/html/boost_typetraits/reference/conditional.html b/doc/html/boost_typetraits/reference/conditional.html index f2a044b..f04fdd7 100644 --- a/doc/html/boost_typetraits/reference/conditional.html +++ b/doc/html/boost_typetraits/reference/conditional.html @@ -27,7 +27,9 @@ conditional

- #include <boost/type_traits/conditional.hpp> + Header: #include + <boost/type_traits/conditional.hpp> + or #include <boost/type_traits.hpp>

namespace boost {
   template <bool B, class T, class U>  struct conditional;
diff --git a/doc/html/boost_typetraits/reference/is_convertible.html b/doc/html/boost_typetraits/reference/is_convertible.html
index 0d23f0c..10a7a60 100644
--- a/doc/html/boost_typetraits/reference/is_convertible.html
+++ b/doc/html/boost_typetraits/reference/is_convertible.html
@@ -106,7 +106,7 @@
         

is_convertible<int, int>::value - is an integral constant expression that evaluates to false. + is an integral constant expression that evaluates to true.

is_convertible<T, T>::value_type diff --git a/doc/html/boost_typetraits/reference/is_stateless.html b/doc/html/boost_typetraits/reference/is_stateless.html index 0786250..ee0c425 100644 --- a/doc/html/boost_typetraits/reference/is_stateless.html +++ b/doc/html/boost_typetraits/reference/is_stateless.html @@ -30,7 +30,7 @@ struct is_stateless : public true_type-or-false_type {};

- Inherits: Ff T is a stateless type then + Inherits: If T is a stateless type then inherits from true_type, otherwise from false_type.

diff --git a/doc/html/boost_typetraits/reference/is_virtual_base_of.html b/doc/html/boost_typetraits/reference/is_virtual_base_of.html index 997dae6..a1beeaa 100644 --- a/doc/html/boost_typetraits/reference/is_virtual_base_of.html +++ b/doc/html/boost_typetraits/reference/is_virtual_base_of.html @@ -83,9 +83,15 @@ that evaluates to true.

- is_virtual_base_of<Base, Derived>::value is an integral constant expression + is_virtual_base_of<SomeClassType, + SomeClassType>::value is an integral constant expression that evaluates to true.

+

+ is_virtual_base_of<NotAClassType, + NotAClassType>::value is an integral constant expression + that evaluates to false. +

is_virtual_base_of<T, U>::value_type is the type bool. diff --git a/doc/html/index.html b/doc/html/index.html index 8c91095..19d4190 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -30,7 +30,7 @@ Marcus, Itay Maman, John Maddock, Alexander Nasonov, Thorsten Ottosen, Robert Ramey and Jeremy Siek

-

+

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/s11.html b/doc/html/index/s11.html index 28ed747..2e8efe8 100644 --- a/doc/html/index/s11.html +++ b/doc/html/index/s11.html @@ -24,7 +24,7 @@

-Class Index

+Class Index

A C D E F H I M P R T

diff --git a/doc/html/index/s12.html b/doc/html/index/s12.html index 3ca1275..fcac226 100644 --- a/doc/html/index/s12.html +++ b/doc/html/index/s12.html @@ -24,7 +24,7 @@

-Typedef Index

+Typedef Index

F R T

diff --git a/doc/html/index/s13.html b/doc/html/index/s13.html index 758c23e..9562420 100644 --- a/doc/html/index/s13.html +++ b/doc/html/index/s13.html @@ -24,7 +24,7 @@

-Macro Index

+Macro Index

B

diff --git a/doc/html/index/s14.html b/doc/html/index/s14.html index 27f7280..b93cab0 100644 --- a/doc/html/index/s14.html +++ b/doc/html/index/s14.html @@ -23,7 +23,7 @@

-Index

+Index

A B C D E F H I M P R S T U

diff --git a/doc/is_convertible.qbk b/doc/is_convertible.qbk index ff6acb1..cbaf2fb 100644 --- a/doc/is_convertible.qbk +++ b/doc/is_convertible.qbk @@ -58,7 +58,7 @@ expression that evaluates to /false/: the conversion would require a `const_cast expression that evaluates to /true/.] [:`is_convertible::value` is an integral constant -expression that evaluates to /false/.] +expression that evaluates to /true/.] [:`is_convertible::value_type` is the type `bool`.] diff --git a/doc/is_stateless.qbk b/doc/is_stateless.qbk index 79db8b1..d2de82f 100644 --- a/doc/is_stateless.qbk +++ b/doc/is_stateless.qbk @@ -9,7 +9,7 @@ template struct is_stateless : public __tof {}; -__inherit Ff T is a stateless type then inherits from __true_type, otherwise +__inherit If T is a stateless type then inherits from __true_type, otherwise from __false_type. Type T must be a complete type. diff --git a/doc/is_virtual_base_of.qbk b/doc/is_virtual_base_of.qbk index f7b5f80..e229bc5 100644 --- a/doc/is_virtual_base_of.qbk +++ b/doc/is_virtual_base_of.qbk @@ -38,9 +38,12 @@ __examples [:`is_virtual_base_of::value` is an integral constant expression that evaluates to /true/.] -[:`is_virtual_base_of::value` is an integral constant +[:`is_virtual_base_of::value` is an integral constant expression that evaluates to /true/.] +[:`is_virtual_base_of::value` is an integral constant +expression that evaluates to /false/.] + [:`is_virtual_base_of::value_type` is the type `bool`.] [endsect]