From e4c057146574d86d1c69c9b37a08eca74451ac78 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Sun, 16 Mar 2008 11:38:32 +0000 Subject: [PATCH] Rebuild a lot of documentation. [SVN r43650] --- doc/html/boost_config/acknowledgements.html | 8 +-- .../boost_config/boost_macro_reference.html | 58 +++++++++++-------- .../guidelines_for_boost_authors.html | 18 +++--- doc/html/boost_config/rationale.html | 10 ++-- doc/html/index.html | 49 ++++++++-------- 5 files changed, 80 insertions(+), 63 deletions(-) diff --git a/doc/html/boost_config/acknowledgements.html b/doc/html/boost_config/acknowledgements.html index 46aa889b..16576d83 100644 --- a/doc/html/boost_config/acknowledgements.html +++ b/doc/html/boost_config/acknowledgements.html @@ -3,7 +3,7 @@ Acknowledgements - + @@ -11,7 +11,7 @@ - + @@ -23,14 +23,14 @@

Beman Dawes provided the original config.hpp and part of this document.

- Vesa Karvonen provided a description of the principles (see rationale) + Vesa Karvonen provided a description of the principles (see rationale) and put together an early version of the current configuration setup.

diff --git a/doc/html/boost_config/boost_macro_reference.html b/doc/html/boost_config/boost_macro_reference.html index 5b2d621d..af47134c 100644 --- a/doc/html/boost_config/boost_macro_reference.html +++ b/doc/html/boost_config/boost_macro_reference.html @@ -3,7 +3,7 @@ Boost Macro Reference - + @@ -12,7 +12,7 @@

Boost C++ LibrariesHomeHome Libraries People FAQ
- + @@ -24,7 +24,7 @@
Macros @@ -44,7 +44,7 @@

@@ -258,7 +258,8 @@ The compiler fails to compile a nested class that has a dependent base class:

-
template<typename T>
+
+template<typename T>
 struct foo : {
    template<typename U>
    struct bar : public U {};
@@ -284,7 +285,8 @@
                 Template value parameters cannot have a dependent type, for example:
                 
 

-
template<class T, typename T::type value> 
+
+template<class T, typename T::type value> 
 class X { ... };
 

@@ -365,7 +367,8 @@ The compiler does not perform function template ordering or its function template ordering is incorrect.

-
// #1
+
+// #1
 template<class T> void f(T);
 
 // #2
@@ -1135,7 +1138,8 @@
                 The compiler does not allow a void function to return the result
                 of calling another void function. 
 

-
void f() {}
+
+void f() {}
 void g() { return f(); }
 

@@ -1149,7 +1153,7 @@

@@ -2162,7 +2166,7 @@

@@ -2276,14 +2280,16 @@ us a convenient way to declare such constants. For example instead of:

-
struct foo{
+
+struct foo{
    static const int value = 2;
 };
 

use:

-
struct foo{
+
+struct foo{
    BOOST_STATIC_CONSTANT(int, value = 2);
 };
 
@@ -2316,7 +2322,8 @@ instantiations if some of the template parameters don't appear in the function parameter list. For instance:

-
#include <iostream>
+
+#include <iostream>
 #include <ostream>
 #include <typeinfo>
 
@@ -2340,7 +2347,8 @@
                 problem without effects on the calling syntax. For instance, in the
                 case above write: 
 

-
template <int n>
+
+template <int n>
 void f(BOOST_EXPLICIT_TEMPLATE_NON_TYPE(int, n)) { ... }
 
 template <typename T>
@@ -2455,7 +2463,7 @@
     

@@ -2694,7 +2702,7 @@

@@ -2711,7 +2719,7 @@

@@ -2734,7 +2742,8 @@

my_library.hpp

-
#ifndef MY_INCLUDE_GUARD
+
+#ifndef MY_INCLUDE_GUARD
 #define MY_INCLUDE_GUARD
 
 // all includes go here:
@@ -2756,7 +2765,8 @@
 

my_library.cpp

-
...
+
+...
 // nothing special need be done in the implementation file
 ...
 
@@ -2769,7 +2779,7 @@

@@ -2821,7 +2831,8 @@

my_library.hpp

-
...
+
+...
 //
 // Don't include auto-linking code if the user has disabled it by
 // defining BOOST_ALL_NO_LIB, or BOOST_MY_LIBRARY_NO_LIB, or if this 
@@ -2839,7 +2850,8 @@
 

my_library.cpp

-
// define BOOST_MY_LIBRARY_SOURCE so that the header knows that the
+
+// define BOOST_MY_LIBRARY_SOURCE so that the header knows that the
 // library is being built (possibly exporting rather than importing code)
 //
 #define BOOST_MY_LIBRARY_SOURCE
diff --git a/doc/html/boost_config/guidelines_for_boost_authors.html b/doc/html/boost_config/guidelines_for_boost_authors.html
index 922412ed..7cd6494c 100644
--- a/doc/html/boost_config/guidelines_for_boost_authors.html
+++ b/doc/html/boost_config/guidelines_for_boost_authors.html
@@ -3,7 +3,7 @@
 
 Guidelines for Boost Authors
 
-
+
 
 
 
@@ -12,7 +12,7 @@
 
 
Boost C++ LibrariesHomeHome Libraries People FAQ
- + @@ -24,7 +24,7 @@
@@ -103,7 +103,7 @@

@@ -125,7 +125,8 @@ the test case in a .ipp file with the following comments near the top:

-
//  MACRO:         BOOST_NO_FOO
+
+//  MACRO:         BOOST_NO_FOO
 //  TITLE:         foo
 //  DESCRIPTION:   If the compiler fails to support foo
 
@@ -138,7 +139,8 @@ the same name as the macro, but in all lower case, and which returns zero on success:

-
namespace boost_no_foo {
+
+namespace boost_no_foo {
 
 int test()
 {
@@ -203,7 +205,7 @@
 

diff --git a/doc/html/boost_config/rationale.html b/doc/html/boost_config/rationale.html index 28845631..a2cb5b16 100644 --- a/doc/html/boost_config/rationale.html +++ b/doc/html/boost_config/rationale.html @@ -3,7 +3,7 @@ Rationale - + @@ -12,7 +12,7 @@

Boost C++ LibrariesHomeHome Libraries People FAQ
- + @@ -24,7 +24,7 @@
The problem
@@ -41,7 +41,7 @@

Consider a situation in which you are concurrently developing on multiple @@ -104,7 +104,7 @@

The approach taken by boost's configuration headers is to separate configuration diff --git a/doc/html/index.html b/doc/html/index.html index f1a6f7c7..aad3b921 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,14 +3,14 @@ Boost.Config - +

Boost C++ LibrariesHomeHome Libraries People FAQ
- + @@ -28,7 +28,7 @@
-

+

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)

@@ -90,7 +90,7 @@
@@ -109,7 +109,7 @@

Boost library implementations access configuration macros via

-
#include <boost/config.hpp>
+
+#include <boost/config.hpp>
 

While Boost library users are not required to include that file directly, @@ -148,10 +149,10 @@ them usable by both Boost library and user code.

- Boost informational or helper + Boost informational or helper macros are designed for use by Boost users as well as for our own internal - use. Note however, that the feature test - and defect test macros were designed + use. Note however, that the feature test + and defect test macros were designed for internal use by Boost libraries, not user code, so they can change at any time (though no gratuitous changes are made to them). Boost library problems resulting from changes to the configuration macros are caught by the Boost @@ -166,7 +167,7 @@

Boost C++ LibrariesHomeHome Libraries People FAQ
@@ -274,7 +275,8 @@ For example to run the configure script with HP aCC, you might use something like:

-
export CXX="aCC"
+
+export CXX="aCC"
 export CXXFLAGS="-Aa -DAportable -D__HPACC_THREAD_SAFE_RB_TREE \
    -DRWSTD_MULTI_THREAD -DRW_MULTI_THREAD -D_REENTRANT -D_THREAD_SAFE"
 export LDFLAGS="-DAportable"
@@ -316,7 +318,7 @@
     

@@ -680,7 +682,7 @@

@@ -705,13 +707,13 @@

Next the compiler, standard library, and platform configuration files are included. These are included via macros (BOOST_COMPILER_CONFIG - etc, see user settable macros), + etc, see user settable macros), and if the corresponding macro is undefined then a separate header that detects which compiler/standard library/platform is in use is included in order to set these. The config can be told to ignore these headers altogether if the corresponding BOOST_NO_XXX macro is set (for example BOOST_NO_COMPILER_CONFIG - to disable including any compiler configuration file - see + to disable including any compiler configuration file - see user settable macros).

@@ -724,7 +726,7 @@

@@ -741,7 +743,8 @@ there. Finally, open up <boost/config/user.hpp> and edit the following defines:

-
#define BOOST_COMPILER_CONFIG "boost/config/mysetup/visualc.hpp"
+
+#define BOOST_COMPILER_CONFIG "boost/config/mysetup/visualc.hpp"
 #define BOOST_STDLIB_CONFIG "boost/config/mysetup/stlport.hpp"
 #define BOOST_USER_CONFIG "boost/config/mysetup/win32.hpp"
 
@@ -756,7 +759,7 @@

If you are working on a unix-like platform then you can use the configure script to generate a "frozen" configuration based on your current - compiler setup - see using the configure + compiler setup - see using the configure script for more details.

- +

Last revised: February 21, 2008 at 16:56:38 GMT

Last revised: March 15, 2008 at 13:57:39 GMT