From 017c095cad3f405453e912f0eedb506127cb80e0 Mon Sep 17 00:00:00 2001 From: Jens Maurer Date: Sun, 12 Nov 2000 18:37:04 +0000 Subject: [PATCH] removed boost/stdint.h from documentation [SVN r8175] --- cstdint.htm | 9 ++++----- index.htm | 38 +++++++++++++++++++------------------- 2 files changed, 23 insertions(+), 24 deletions(-) diff --git a/cstdint.htm b/cstdint.htm index ab4c4c1..bb8ac63 100644 --- a/cstdint.htm +++ b/cstdint.htm @@ -12,11 +12,10 @@

c++boost.gif (8819 bytes)Header boost/cstdint.hpp 

The header <boost/cstdint.hpp> -places the contents of the header <boost/stdint.h> -in namespace boost.  That header consists entirely of typedef's useful for -writing portable code that requires certain integer widths.

+provides the typedef's useful for +writing portable code that requires certain integer widths. All typedef's are in namespace boost.

The specifications are based on the ISO/IEC 9899:1999 C Language standard -header stdint.h.  The 64-bit types required by the C standard are not +header <stdint.h>.  The 64-bit types required by the C standard are not required in the boost header, and may not be supplied in all implementations, because long long is not [yet] included in the C++ standard.

See cstdint_test.cpp for a test program.

@@ -70,7 +69,7 @@ representing any value of any signed integer type.

capable of representing any value of any unsigned integer type.

These types are required.

-

Revised 29 Jun 2000 +

Revised 12 Nov 2000

 

diff --git a/index.htm b/index.htm index 6439cbb..5d968d5 100644 --- a/index.htm +++ b/index.htm @@ -34,19 +34,12 @@
documentation - Contents of <boost/stdint.h> wrapped in namespace boost. + Typedef's based on the 1999 C Standard header <stdint.h>, wrapped in namespace boost. + This implementation may #include the compiler + supplied <stdint.h>, if present. Supplies typedefs for standard integer types such as int32_t or uint_least16_t. - Use in preference to <stdint.h> or <boost/stdint.h> - because the names are safely placed in the boost namespace. - - - <boost/stdint.h> - Typedefs as defined in the C99 standard header <stdint.h>. - This implementation #includes the compiler - supplied <stdint.h>, if present. - Supplied - for use in the implementation of <boost/cstdint.hpp> and to ease transition to the C99 standard. - Other uses are not recommended because this header places its names in the global namespace.  + Use in preference to <stdint.h> + for enhanced portability. Furthermore, all names are safely placed in the boost namespace. <boost/integer_traits.hpp>
@@ -70,17 +63,16 @@

Rationale

The organization of boost integer headers and classes is designed to take -advantage of <stdint.h> types from in the 1999 C standard +advantage of <stdint.h> types from the 1999 C standard without resorting to undefined behavior in terms of the 1998 C++ standard.  The header <boost/cstdint.hpp> -makes the standard integer types safely available in namespace boost without placing any names in the -global namespace or namespace std. As always, the intension is to complement rather than +makes the standard integer types safely available in namespace boost without placing any names in namespace std. As always, the intension is to complement rather than compete with the C++ Standard Library.  Should some future C++ standard -include <stdint.h> and <cstdint>, then <boost/stdint.h> and <boost/cstdint.hpp> +include <stdint.h> and <cstdint>, then <boost/cstdint.hpp> will continue to function, but will become redundant and may be safely deprecated.

Because these are boost headers, their names conform to boost header naming -conventions rather than C++ Standard Library header naming conventions.  An -exception is <boost/stdint.h> which uses a .h extension to indicate its C rather than C++ heritage.

+conventions rather than C++ Standard Library header naming conventions. +

Caveat emptor

As an implementation artifact, certain C <limits.h> macro names may possibly be @@ -88,9 +80,17 @@ visible to users of <boost/cstdint.hpp>.  Don't use these macros; the any Boost specified interface.  Use boost:: integer_traits<> or std::numeric_limits<> instead.

+

+As another implementation artifact, certain C +<stdint.h> typedef names may possibly be visible in the +global namespace to users of <boost/cstdint.hpp>. +Don't use these names, they are not part of any Boost specified +interface. Use the respective names in namespace boost +instead. +

-

Revised: 10 Nov 2000 +

Revised: 12 Nov 2000