From 6f6925083a53bda27047652f6b62c6ac5695f19c Mon Sep 17 00:00:00 2001 From: Antony Polukhin Date: Wed, 4 Jul 2012 23:12:52 +0400 Subject: [PATCH] Documentation update --- boost/operator_idp5190080.html | 55 +++++++++++++++++++++++++++ boost/template_id.html | 2 +- boost/template_id_with_cvr.html | 2 +- boost/template_index.html | 44 ++++++++++----------- boost/type_id.html | 8 ++-- boost/type_id_rtti_on_idp5183808.html | 54 ++++++++++++++++++++++++++ boost/type_id_rtti_on_idp5186944.html | 54 ++++++++++++++++++++++++++ boost/type_index.html | 48 +++++++++++------------ boost_typeindex/performance.html | 6 +-- boost_typeindex_header_reference.html | 12 +++--- index.html | 2 +- standalone_HTML.manifest | 6 +-- 12 files changed, 228 insertions(+), 65 deletions(-) create mode 100644 boost/operator_idp5190080.html create mode 100644 boost/type_id_rtti_on_idp5183808.html create mode 100644 boost/type_id_rtti_on_idp5186944.html diff --git a/boost/operator_idp5190080.html b/boost/operator_idp5190080.html new file mode 100644 index 0000000..a6c44dd --- /dev/null +++ b/boost/operator_idp5190080.html @@ -0,0 +1,55 @@ + + + +Function operator<< + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function operator<<

+

boost::operator<<

+
+

Synopsis

+
// In header: <boost/type_index.hpp>
+
+
+std::basic_ostream & 
+operator<<(std::basic_ostream, template_index/type_index const & rhs);
+
+

Description

+

Output operators for type_index and template_index

+
+
+ + + +
Copyright © 2012 Antony Polukhin

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

+
+
+
+PrevUpHomeNext +
+ + diff --git a/boost/template_id.html b/boost/template_id.html index e6d31f5..f0998be 100644 --- a/boost/template_id.html +++ b/boost/template_id.html @@ -34,7 +34,7 @@ template<typename T> template_index template_id();
-

Description

+

Description

Method for constructing template_index instance for type T. Strips const, volatile and & modifiers from T.

diff --git a/boost/template_id_with_cvr.html b/boost/template_id_with_cvr.html index 9658fb1..d6e51ac 100644 --- a/boost/template_id_with_cvr.html +++ b/boost/template_id_with_cvr.html @@ -34,7 +34,7 @@ template<typename T> template_index template_id_with_cvr();
-

Description

+

Description

Factory method for constructing template_index instance for type T. Does not strips const, volatile and & modifiers from T.

diff --git a/boost/template_index.html b/boost/template_index.html index 171f884..e9e5d5f 100644 --- a/boost/template_index.html +++ b/boost/template_index.html @@ -35,59 +35,59 @@ class template_index { public: // construct/copy/destruct - template_index(); + template_index(); - // public member functions - bool before(const template_index &) const; - const char * name() const; - std::string name_demangled() const; - std::size_t hash_code() const; + // public member functions + bool before(const template_index &) const; + const char * name() const; + std::string name_demangled() const; + std::size_t hash_code() const; - // public static functions - template<typename T> static template_index construct(); - template<typename T> static template_index construct_with_cvr(); + // public static functions + template<typename T> static template_index construct(); + template<typename T> static template_index construct_with_cvr(); };
-

Description

+

Description

Copyable type_info that does not require RTTI and could store const, volatile and references if constructed via construct_with_cvr()

-

+

template_index public construct/copy/destruct

  1. -
    template_index();
    +
    template_index();

    Default constructor.

-

-template_index public member functions

+

+template_index public member functions

  1. -
    bool before(const template_index & rhs) const;
    +
    bool before(const template_index & rhs) const;

    Returns true if the type precedes the type of rhs in the collation order. The collation order is just an internal order.

  2. -
    const char * name() const;
    Retrurns raw name.
    3. +
    const char * name() const;
    Returns raw name.
  3. -
    std::string name_demangled() const;
    Retrurns user-friendly name.
    4. +
    std::string name_demangled() const;
    Returns user-friendly name.
  4. -
    std::size_t hash_code() const;
    +
    std::size_t hash_code() const;

    Function for getting hash value

-

-template_index public static functions

+

+template_index public static functions

  1. -
    template<typename T> static template_index construct();
    +
    template<typename T> static template_index construct();

    Factory method for constructing template_index instance for type T. Strips const, volatile and & modifiers from T

  2. -
    template<typename T> static template_index construct_with_cvr();
    +
    template<typename T> static template_index construct_with_cvr();

    Factory method for constructing template_index instance for type T. Does not strips const, volatile and & modifiers from T

diff --git a/boost/type_id.html b/boost/type_id.html index 696eb40..535ba9d 100644 --- a/boost/type_id.html +++ b/boost/type_id.html @@ -7,7 +7,7 @@ - + @@ -20,7 +20,7 @@
-PrevUpHomeNext +PrevUpHomeNext
@@ -34,7 +34,7 @@ template<typename T> type_index type_id();
-

Description

+

Description

Function, to get type_index for a type T. Strips const, volatile and & modifiers from T.

@@ -48,7 +48,7 @@
-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/type_id_rtti_on_idp5183808.html b/boost/type_id_rtti_on_idp5183808.html new file mode 100644 index 0000000..3a4ab9f --- /dev/null +++ b/boost/type_id_rtti_on_idp5183808.html @@ -0,0 +1,54 @@ + + + +Function template type_id_rtti_only + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template type_id_rtti_only

+

boost::type_id_rtti_only

+
+

Synopsis

+
// In header: <boost/type_index.hpp>
+
+
+template<typename T> type_index type_id_rtti_only(T & rtti_val);
+
+

Description

+

Function, that works exactly like C++ typeid(rtti_val) call, but returns boost::type_index. This method available only with RTTI enabled.

+
+
+ + + +
Copyright © 2012 Antony Polukhin

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

+
+
+
+PrevUpHomeNext +
+ + diff --git a/boost/type_id_rtti_on_idp5186944.html b/boost/type_id_rtti_on_idp5186944.html new file mode 100644 index 0000000..8f552b6 --- /dev/null +++ b/boost/type_id_rtti_on_idp5186944.html @@ -0,0 +1,54 @@ + + + +Function template type_id_rtti_only + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+
+
+

Function template type_id_rtti_only

+

boost::type_id_rtti_only

+
+

Synopsis

+
// In header: <boost/type_index.hpp>
+
+
+template<typename T> type_index type_id_rtti_only(T * rtti_val);
+
+

Description

+

Function, that works exactly like C++ typeid(rtti_val) call, but returns boost::type_index. This method available only with RTTI enabled.

+
+
+ + + +
Copyright © 2012 Antony Polukhin

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

+
+
+
+PrevUpHomeNext +
+ + diff --git a/boost/type_index.html b/boost/type_index.html index c71fd87..bc465fb 100644 --- a/boost/type_index.html +++ b/boost/type_index.html @@ -38,61 +38,61 @@ typedef std::type_info stl_type_info; // construct/copy/destruct - type_index(); + type_index(); - // public member functions - bool before(type_index const &) const; - const char * name() const; - std::string name_demangled() const; - std::size_t hash_code() const; + // public member functions + bool before(type_index const &) const; + const char * name() const; + std::string name_demangled() const; + std::size_t hash_code() const; - // public static functions - template<typename T> static type_index construct(); - template<typename T> static type_index construct_rtti_only(T &); - template<typename T> static type_index construct_rtti_only(T *); + // public static functions + template<typename T> static type_index construct(); + template<typename T> static type_index construct_rtti_only(T &); + template<typename T> static type_index construct_rtti_only(T *); };
-

Description

+

Description

-

+

type_index public construct/copy/destruct

  1. -
    type_index();
    +
    type_index();

    Default constructor.

-

-type_index public member functions

+

+type_index public member functions

  1. -
    bool before(type_index const & rhs) const;
    +
    bool before(type_index const & rhs) const;

    Returns true if the type precedes the type of rhs in the collation order. The collation order is just an internal order.

  2. -
    const char * name() const;
    Retrurns raw name.
    3. +
    const char * name() const;
    Returns raw name.
  3. -
    std::string name_demangled() const;
    Retrurns user-friendly name.
    4. +
    std::string name_demangled() const;
    Returns user-friendly name.
  4. -
    std::size_t hash_code() const;
    Function for getting hash value.
    5. +
    std::size_t hash_code() const;
    Function for getting hash value.
-

-type_index public static functions

+

+type_index public static functions

  1. -
    template<typename T> static type_index construct();
    +
    template<typename T> static type_index construct();

    Factory method for constructing type_index instance for type T. Strips const, volatile and & modifiers from T.

  2. -
    template<typename T> static type_index construct_rtti_only(T & rtti_val);
    +
    template<typename T> static type_index construct_rtti_only(T & rtti_val);

    Factory function, that works exactly like C++ typeid(rtti_val) call, but returns boost::type_index. This method available only with RTTI enabled.

  3. -
    template<typename T> static type_index construct_rtti_only(T * rtti_val);
    +
    template<typename T> static type_index construct_rtti_only(T * rtti_val);

    Factory function, that works exactly like C++ typeid(rtti_val) call, but returns boost::type_index. This method available only with RTTI enabled.

diff --git a/boost_typeindex/performance.html b/boost_typeindex/performance.html index 2b9acc9..65db40e 100644 --- a/boost_typeindex/performance.html +++ b/boost_typeindex/performance.html @@ -6,7 +6,7 @@ - + @@ -19,7 +19,7 @@
-PrevUpHome +PrevUpHome

@@ -58,7 +58,7 @@
-PrevUpHome +PrevUpHome
diff --git a/boost_typeindex_header_reference.html b/boost_typeindex_header_reference.html index e670103..ed38ab8 100644 --- a/boost_typeindex_header_reference.html +++ b/boost_typeindex_header_reference.html @@ -35,20 +35,20 @@ template<typename T> template_index template_id(); template<typename T> template_index template_id_with_cvr(); template<typename T> type_index type_id(); - template<typename T> type_index type_id_rtti_only(T &); - template<typename T> type_index type_id_rtti_only(T *); + template<typename T> type_index type_id_rtti_only(T &); + template<typename T> type_index type_id_rtti_only(T *); std::basic_ostream & - operator<<(std::basic_ostream, template_index/type_index const &); + operator<<(std::basic_ostream, template_index/type_index const &); // All possible operators for comparison of std::type_info's and type_index'es. - bool operator(type_index/std::type_info const & lhs, + bool operator(type_index/std::type_info const & lhs, type_index/std::type_info const & rhs); // All possible operators for comparison of template_index'es. - bool operator(template_index const & lhs, template_index const & rhs); + bool operator(template_index const & lhs, template_index const & rhs); // All possible operators for comparison of type_index'es. - bool operator(type_index const & lhs, type_index const & rhs); + bool operator(type_index const & lhs, type_index const & rhs); }

diff --git a/index.html b/index.html index 3fd8bde..59ec41b 100644 --- a/index.html +++ b/index.html @@ -107,7 +107,7 @@
- +

Last revised: June 26, 2012 at 17:10:49 GMT

Last revised: July 04, 2012 at 19:12:10 GMT
diff --git a/standalone_HTML.manifest b/standalone_HTML.manifest index 0014944..af60ce4 100644 --- a/standalone_HTML.manifest +++ b/standalone_HTML.manifest @@ -7,7 +7,7 @@ boost/type_index.html boost/template_id.html boost/template_id_with_cvr.html boost/type_id.html -boost/type_id_rtti_on_idp5202400.html -boost/type_id_rtti_on_idp5205536.html -boost/operator_idp5208672.html +boost/type_id_rtti_on_idp5183808.html +boost/type_id_rtti_on_idp5186944.html +boost/operator_idp5190080.html boost_typeindex/performance.html