Updated the docs for header files.

This commit is contained in:
Antony Polukhin
2013-10-12 20:04:10 +04:00
parent 9cf27718b6
commit 2557b1f8e1
6 changed files with 32 additions and 6 deletions

View File

@@ -8,8 +8,14 @@
#ifndef BOOST_TYPE_INDEX_HPP
#define BOOST_TYPE_INDEX_HPP
/// \file type_index.hpp
/// \brief 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.
// MS compatible compilers support #pragma once
#if defined(_MSC_VER) && (_MSC_VER >= 1020)
#if defined(_MSC_VER)
# pragma once
#endif

View File

@@ -14,6 +14,12 @@
# pragma once
#endif
/// \file template_index_impl.hpp
/// \brief 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.
#include <cstring>
#include <string>
#include <boost/config.hpp>

View File

@@ -13,6 +13,13 @@
# pragma once
#endif
/// \file type_index_impl.hpp
/// \brief 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.
#include <cstring>
#include <string>
#include <boost/config.hpp>

View File

@@ -10,10 +10,16 @@
#define BOOST_TYPE_INDEX_TYPE_INDEX_MINIMAL_HPP
// MS compatible compilers support #pragma once
#if defined(_MSC_VER) && (_MSC_VER >= 1020)
#if defined(_MSC_VER)
# pragma once
#endif
/// \file type_index_minimal.hpp
/// \brief 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.
#ifndef BOOST_NO_RTTI
# include <boost/type_index/type_index_impl.hpp>
#else

View File

@@ -10,6 +10,7 @@ import doxygen ;
doxygen autodoc
:
[ glob ../../../boost/type_index.hpp ]
[ glob ../../../boost/type_index/* ]
:
<doxygen:param>EXTRACT_ALL=NO
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
@@ -35,7 +36,7 @@ boostbook standalone
:
type_index
:
<xsl:param>boost.root=http://www.boost.org/doc/libs/1_49_0
<xsl:param>boost.root=http://www.boost.org/doc/libs/1_53_0
# <xsl:param>boost.root=../../../..
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/doc/html
<dependency>autodoc

View File

@@ -1,7 +1,7 @@
[library Boost.TypeIndex
[quickbook 1.5]
[version 1.0]
[copyright 2012 Antony Polukhin]
[copyright 2012-2013 Antony Polukhin]
[category Language Features Emulation]
[license
Distributed under the Boost Software License, Version 1.0.
@@ -16,11 +16,11 @@ Sometimes getting and storing information about a template type at runtime is re
* `typeid(T)` and `std::type_index` require Run Time Type Info (RTTI)
* some implementations of `typeid(T)` strip const, volatile and references from type, while others don't
* some compilers have bugs and do not correctly compare `std::type_info` 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
* no nice and portable way to get human readable type names
Boost.TypeIndex was designed to work around those issues.
Boost.TypeIndex was designed to work around all those issues.
[note `T` means type here. Think of it as of `T` in `template <class T>` ]