From b9f3db90fca2c6feb80019b05feef49982243b2f Mon Sep 17 00:00:00 2001 From: Antony Polukhin Date: Sat, 12 Oct 2013 20:15:33 +0400 Subject: [PATCH] Docs regenerated. --- boost/template_id.html | 24 +++--- boost/template_id_with_cvr.html | 24 +++--- boost/template_index.html | 66 +++++++-------- ...0.html => type_id_rtti_on_idp5197920.html} | 28 +++---- ...6.html => type_id_rtti_on_idp5201056.html} | 26 +++--- boost/type_index.html | 76 +++++++++--------- boost_typeindex/compiler_support.html | 18 ++--- boost_typeindex/examples.html | 18 ++--- boost_typeindex/getting_started.html | 18 ++--- boost_typeindex/performance.html | 20 ++--- boost_typeindex_header_reference.html | 80 ++++++++++++------- index.html | 35 ++++---- standalone_HTML.manifest | 6 +- 13 files changed, 233 insertions(+), 206 deletions(-) rename boost/{type_id_rtti_on_idp5555120.html => type_id_rtti_on_idp5197920.html} (56%) rename boost/{type_id_rtti_on_idp5558256.html => type_id_rtti_on_idp5201056.html} (60%) diff --git a/boost/template_id.html b/boost/template_id.html index 712c571..0e29a2d 100644 --- a/boost/template_id.html +++ b/boost/template_id.html @@ -2,25 +2,25 @@ Function template template_id - + - - + + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
@@ -29,18 +29,18 @@

boost::template_id

Synopsis

-
// In header: <boost/type_index.hpp>
+
// In header: <boost/type_index/template_index_impl.hpp>
 
 
 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.

-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/template_id_with_cvr.html b/boost/template_id_with_cvr.html index 5ed5944..c05b9dd 100644 --- a/boost/template_id_with_cvr.html +++ b/boost/template_id_with_cvr.html @@ -2,25 +2,25 @@ Function template template_id_with_cvr - + - + - + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
@@ -29,18 +29,18 @@

boost::template_id_with_cvr

Synopsis

-
// In header: <boost/type_index.hpp>
+
// In header: <boost/type_index/template_index_impl.hpp>
 
 
 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.

-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/template_index.html b/boost/template_index.html index 08e12b6..55cbf13 100644 --- a/boost/template_index.html +++ b/boost/template_index.html @@ -2,25 +2,25 @@ Class template_index - + - + - + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
@@ -29,61 +29,61 @@

boost::template_index

Synopsis

-
// In header: <boost/type_index.hpp>
+
// In header: <boost/type_index/template_index_impl.hpp>
 
 
 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();
    Default constructor.
+
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;
    Returns raw name.
  3. +
    const char * name() const;
    Returns raw name.
  4. -
    std::string name_demangled() const;
    Returns user-friendly name.
  5. +
    std::string name_demangled() const;
    Returns user-friendly name.
  6. -
    std::size_t hash_code() const;
    Function for getting hash value.
  7. +
    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

@@ -92,7 +92,7 @@
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/type_id_rtti_on_idp5555120.html b/boost/type_id_rtti_on_idp5197920.html similarity index 56% rename from boost/type_id_rtti_on_idp5555120.html rename to boost/type_id_rtti_on_idp5197920.html index 780a6f9..c727481 100644 --- a/boost/type_id_rtti_on_idp5555120.html +++ b/boost/type_id_rtti_on_idp5197920.html @@ -2,45 +2,45 @@ Function template type_id_rtti_only - + - - - + + + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+

Function template type_id_rtti_only

boost::type_id_rtti_only

Synopsis

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

Description

+

Description

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

-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/type_id_rtti_on_idp5558256.html b/boost/type_id_rtti_on_idp5201056.html similarity index 60% rename from boost/type_id_rtti_on_idp5558256.html rename to boost/type_id_rtti_on_idp5201056.html index 74630ec..b59e355 100644 --- a/boost/type_id_rtti_on_idp5558256.html +++ b/boost/type_id_rtti_on_idp5201056.html @@ -2,45 +2,45 @@ Function template type_id_rtti_only - + - - + + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+

Function template type_id_rtti_only

boost::type_id_rtti_only

Synopsis

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

Description

+

Description

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

-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost/type_index.html b/boost/type_index.html index 57c01d3..dc47b30 100644 --- a/boost/type_index.html +++ b/boost/type_index.html @@ -2,25 +2,25 @@ Class type_index - + - - - + + + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
@@ -29,7 +29,7 @@

boost::type_index — Copyable type_info class that requires RTTI.

Synopsis

-
// In header: <boost/type_index.hpp>
+
// In header: <boost/type_index/type_index_impl.hpp>
 
 
 class type_index {
@@ -38,64 +38,64 @@
   typedef std::type_info stl_type_info;
 
   // construct/copy/destruct
-  type_index();
-  explicit type_index(const stl_type_info &);
+  type_index();
+  explicit type_index(const stl_type_info &);
 
-  // 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();
    Default constructor.
  2. +
    type_index();
    Default constructor.
  3. -
    explicit type_index(const stl_type_info & inf);
    Constructs type_index from an instance of std::type_info.
  4. +
    explicit type_index(const stl_type_info & inf);
    Constructs type_index from an instance of std::type_info.
-

-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;
    Returns raw name.
  3. +
    const char * name() const;
    Returns raw name.
  4. -
    std::string name_demangled() const;
    Returns user-friendly name.
  5. +
    std::string name_demangled() const;
    Returns user-friendly name.
  6. -
    std::size_t hash_code() const;
    Function for getting hash value.
  7. +
    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.

@@ -104,7 +104,7 @@
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost_typeindex/compiler_support.html b/boost_typeindex/compiler_support.html index cdc85c9..2524397 100644 --- a/boost_typeindex/compiler_support.html +++ b/boost_typeindex/compiler_support.html @@ -2,7 +2,7 @@ Compiler support - + @@ -10,18 +10,18 @@ - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHome +PrevUpHome
-
+
@@ -73,7 +73,7 @@
-

-PrevUpHome +PrevUpHome
diff --git a/boost_typeindex/examples.html b/boost_typeindex/examples.html index 809559f..7d8e93c 100644 --- a/boost_typeindex/examples.html +++ b/boost_typeindex/examples.html @@ -2,7 +2,7 @@ Examples - + @@ -11,18 +11,18 @@ - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -105,7 +105,7 @@
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost_typeindex/getting_started.html b/boost_typeindex/getting_started.html index e1249f7..d07fc7d 100644 --- a/boost_typeindex/getting_started.html +++ b/boost_typeindex/getting_started.html @@ -2,7 +2,7 @@ Getting started - + @@ -11,18 +11,18 @@ - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -62,7 +62,7 @@
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost_typeindex/performance.html b/boost_typeindex/performance.html index 67a38f0..6e7bfe5 100644 --- a/boost_typeindex/performance.html +++ b/boost_typeindex/performance.html @@ -2,27 +2,27 @@ Performance - + - + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+
@@ -50,7 +50,7 @@
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/boost_typeindex_header_reference.html b/boost_typeindex_header_reference.html index 53e6751..0d0ff9e 100644 --- a/boost_typeindex_header_reference.html +++ b/boost_typeindex_header_reference.html @@ -2,7 +2,7 @@ Boost.TypeIndex Header Reference - + @@ -11,54 +11,76 @@ - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-PrevUpHomeNext +PrevUpHomeNext
-
+ +

Includes all the headers of the Boost.TypeIndex library.

+

By inclusion of this file classes type_index (if RTTI is on) and template_index will be available. Consider including <boost/type_index/type_index_minimal.hpp> if you need only a type_index type with and without RTTI.

+
+
+ +

Contains implementation of template_index class.

+

Here is defined the template_index class, that is used instead of type_index class in situations when RTTI is disabled. Consider including <boost/type_index/type_index_minimal.hpp> or <boost/type_index.hpp> instead of this file.

namespace boost {
   class template_index;
-  class type_index;
   template<typename T> template_index template_id();
   template<typename T> template_index template_id_with_cvr();
 
+  // Ostream operator that will output demangled name. 
+  template<typename CharT, typename TriatT> 
+    std::basic_ostream< CharT, TriatT > & 
+    operator<<(std::basic_ostream< CharT, TriatT > & ostr, 
+               template_index const & ind);
+
+  // hash_value function overload for template_index
+  std::size_t hash_value(template_index const & v);
+}
+
+
+ +

Contains implementation of type_index class.

+

Here is defined the type_index class, that is used in situations when RTTI is enabled. Consider including <boost/type_index/type_index_minimal.hpp> or <boost/type_index.hpp> instead of this file.

+
namespace boost {
+  class type_index;
+
   // Function, to get type_index for a type T. Strips const, volatile and & modifiers from T. 
   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 *);
-
-  // Output operators for type_index and template_index. 
-  std::basic_ostream & 
-  operator<<(std::basic_ostream, template_index/type_index const & rhs);
-
-  // All possible operators for comparison of std::type_info's and type_index'es. 
-  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);
-
-  // All possible operators for comparison of type_index'es. 
-  bool operator(type_index const & lhs, type_index const & rhs);
+  template<typename T> type_index type_id_rtti_only(T &);
+  template<typename T> type_index type_id_rtti_only(T *);
 }
+
+ +

This is the header that required for ussage of type_index with/without RTTI.

+

It includes only the minamally required headers and does the typedef template_index type_index; when RTTI is disabled.

+
-

-PrevUpHomeNext +PrevUpHomeNext
diff --git a/index.html b/index.html index c780cf9..abb1d6c 100644 --- a/index.html +++ b/index.html @@ -2,27 +2,27 @@ Chapter 1. Boost.TypeIndex 1.0 - + - - - + + + - +
Boost C++ LibrariesHomeLibrariesBoost C++ LibrariesHomeLibraries People FAQMoreMore

-
Next
+
Next

Chapter 1. Boost.TypeIndex 1.0

-
+
-
+
@@ -66,7 +71,7 @@ objects across shared libraries
  • - only a few implementations already provide std::type_index + only a few implementations of Standart Library currently provide std::type_index
  • no easy way to store type info without stripping const, volatile and references @@ -76,14 +81,14 @@
  • - Boost.TypeIndex was designed to work around those issues. + Boost.TypeIndex was designed to work around all those issues.

    

    - +
    [Note][Note] Note

    @@ -93,7 +98,7 @@

    - +
    [Warning][Warning] Warning

    @@ -103,10 +108,10 @@ - +

    Last revised: March 04, 2013 at 20:02:24 GMT

    Last revised: October 12, 2013 at 15:58:32 GMT


    -
    Next
    +
    Next
    diff --git a/standalone_HTML.manifest b/standalone_HTML.manifest index fb35c04..bc4620b 100644 --- a/standalone_HTML.manifest +++ b/standalone_HTML.manifest @@ -3,10 +3,10 @@ boost_typeindex/getting_started.html boost_typeindex/examples.html boost_typeindex_header_reference.html boost/template_index.html -boost/type_index.html boost/template_id.html boost/template_id_with_cvr.html -boost/type_id_rtti_on_idp5555120.html -boost/type_id_rtti_on_idp5558256.html +boost/type_index.html +boost/type_id_rtti_on_idp5197920.html +boost/type_id_rtti_on_idp5201056.html boost_typeindex/performance.html boost_typeindex/compiler_support.html