From 9f1b6471d95e372f555e6baa7acae7cf8ff5772d Mon Sep 17 00:00:00 2001 From: John Maddock Date: Sun, 20 Apr 2008 12:53:37 +0000 Subject: [PATCH] Added docs for new warning_disable.hpp header. [SVN r44620] --- doc/guidelines.qbk | 26 ++++++ .../guidelines_for_boost_authors.html | 81 +++++++++++++++++++ doc/html/index.html | 4 +- 3 files changed, 110 insertions(+), 1 deletion(-) diff --git a/doc/guidelines.qbk b/doc/guidelines.qbk index bd89209f..528e93cd 100644 --- a/doc/guidelines.qbk +++ b/doc/guidelines.qbk @@ -59,6 +59,32 @@ at that. majority of compilers, such as namespaces, exceptions, RTTI, or templates. +[section:warnings Disabling Compiler Warings] + +The header `` can be used to disable +certain compiler warings that are hard or impossible to otherwise remove. + +Note that: + +* This header [*['should never be included by another Boost header]], it should +only ever be used by a library source file or a test case. +* The header should be included [*['before you include any other header]]. +* This header only disables warnings that are hard or impossible to otherwise + deal with, and which are typically emitted by one compiler only, or + in one compilers own standard library headers. + +Currently it disables the following warnings: + +[table +[[Compiler][Warning]] +[[Visual C++ 8 and later][[@http://msdn2.microsoft.com/en-us/library/ttcz0bys(VS.80).aspx C4996]: Error 'function': was declared deprecated]] +[[Intel C++][Warning 1786: relates to the use of "deprecated" standard + library functions rather like C4996 in Visual C++.]] +] + +[endsect] + + [section Adding New Defect Macros] When you need to add a new defect macro -either to fix a problem with an diff --git a/doc/html/boost_config/guidelines_for_boost_authors.html b/doc/html/boost_config/guidelines_for_boost_authors.html index 0b53b618..fb4839bd 100644 --- a/doc/html/boost_config/guidelines_for_boost_authors.html +++ b/doc/html/boost_config/guidelines_for_boost_authors.html @@ -28,6 +28,8 @@ Boost Authors
+
+ Disabling Compiler Warings
Adding New Defect Macros
Adding @@ -103,6 +105,85 @@
+

+ The header <boost/config/warning_disable.hpp> + can be used to disable certain compiler warings that are hard or impossible + to otherwise remove. +

+

+ Note that: +

+
    +
  • + This header should never be included by + another Boost header, it should only ever be used + by a library source file or a test case. +
    • +
  • + The header should be included before you + include any other header. +
    • +
  • + This header only disables warnings that are hard or impossible to otherwise + deal with, and which are typically emitted by one compiler only, or in + one compilers own standard library headers. +
    • +
+

+ Currently it disables the following warnings: +

+
++++ + + + + + + + + + + + + + + +
+

+ Compiler +

+ 		+

+ Warning +

+
+

+ Visual C++ 8 and later +

+ 		+

+ C4996: + Error 'function': was declared deprecated +

+
+

+ Intel C++ +

+ 		+

+ Warning 1786: relates to the use of "deprecated" standard + library functions rather like C4996 in Visual C++. +

+
+
+
+
diff --git a/doc/html/index.html b/doc/html/index.html index 565c0781..46fd33d8 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -73,6 +73,8 @@
Guidelines for Boost Authors
+
+ Disabling Compiler Warings
Adding New Defect Macros
Adding @@ -958,7 +960,7 @@

- +

Last revised: April 04, 2008 at 08:46:37 GMT

Last revised: April 20, 2008 at 12:51:56 GMT