Changeset 44620


Ignore:
Timestamp:
Apr 20, 2008, 12:53:37 PM (10 years ago)
Author:
John Maddock
Message:

Added docs for new warning_disable.hpp header.

Location:
trunk/libs/config/doc
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/libs/config/doc/guidelines.qbk

    r37818 r44620  
    6060
    6161
     62[section:warnings Disabling Compiler Warings]
     63
     64The header `<boost/config/warning_disable.hpp>` can be used to disable
     65certain compiler warings that are hard or impossible to otherwise remove.
     66
     67Note that:
     68
     69* This header [*['should never be included by another Boost header]], it should
     70only ever be used by a library source file or a test case.
     71* The header should be included [*['before you include any other header]].
     72* This header only disables warnings that are hard or impossible to otherwise
     73 deal with, and which are typically emitted by one compiler only, or
     74 in one compilers own standard library headers.
     75 
     76Currently it disables the following warnings:
     77
     78[table
     79[[Compiler][Warning]]
     80[[Visual C++ 8 and later][[@http://msdn2.microsoft.com/en-us/library/ttcz0bys(VS.80).aspx C4996]: Error 'function': was declared deprecated]]
     81[[Intel C++][Warning 1786: relates to the use of "deprecated" standard
     82   library functions rather like C4996 in Visual C++.]]
     83]
     84
     85[endsect]
     86
     87
    6288[section Adding New Defect Macros]
    6389
  • trunk/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html

    r43914 r44620  
    2929</h2></div></div></div>
    3030<div class="toc"><dl>
     31<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings">
     32      Disabling Compiler Warings</a></span></dt>
    3133<dt><span class="section"><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
    3234      New Defect Macros</a></span></dt>
     
    102104      </li>
    103105</ul></div>
     106<div class="section" lang="en">
     107<div class="titlepage"><div><div><h3 class="title">
     108<a name="boost_config.guidelines_for_boost_authors.warnings"></a><a href="guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings" title="Disabling Compiler Warings">
     109      Disabling Compiler Warings</a>
     110</h3></div></div></div>
     111<p>
     112        The header <code class="computeroutput"><span class="special">&lt;</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">warning_disable</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">&gt;</span></code>
     113        can be used to disable certain compiler warings that are hard or impossible
     114        to otherwise remove.
     115      </p>
     116<p>
     117        Note that:
     118      </p>
     119<div class="itemizedlist"><ul type="disc">
     120<li>
     121          This header <span class="bold"><strong><span class="emphasis"><em>should never be included by
     122          another Boost header</em></span></strong></span>, it should only ever be used
     123          by a library source file or a test case.
     124        </li>
     125<li>
     126          The header should be included <span class="bold"><strong><span class="emphasis"><em>before you
     127          include any other header</em></span></strong></span>.
     128        </li>
     129<li>
     130          This header only disables warnings that are hard or impossible to otherwise
     131          deal with, and which are typically emitted by one compiler only, or in
     132          one compilers own standard library headers.
     133        </li>
     134</ul></div>
     135<p>
     136        Currently it disables the following warnings:
     137      </p>
     138<div class="informaltable"><table class="table">
     139<colgroup>
     140<col>
     141<col>
     142</colgroup>
     143<thead><tr>
     144<th>
     145              <p>
     146                Compiler
     147              </p>
     148              </th>
     149<th>
     150              <p>
     151                Warning
     152              </p>
     153              </th>
     154</tr></thead>
     155<tbody>
     156<tr>
     157<td>
     158              <p>
     159                Visual C++ 8 and later
     160              </p>
     161              </td>
     162<td>
     163              <p>
     164                <a href="http://msdn2.microsoft.com/en-us/library/ttcz0bys(VS.80).aspx" target="_top">C4996</a>:
     165                Error 'function': was declared deprecated
     166              </p>
     167              </td>
     168</tr>
     169<tr>
     170<td>
     171              <p>
     172                Intel C++
     173              </p>
     174              </td>
     175<td>
     176              <p>
     177                Warning 1786: relates to the use of "deprecated" standard
     178                library functions rather like C4996 in Visual C++.
     179              </p>
     180              </td>
     181</tr>
     182</tbody>
     183</table></div>
     184</div>
    104185<div class="section" lang="en">
    105186<div class="titlepage"><div><div><h3 class="title">
  • trunk/libs/config/doc/html/index.html

    r44029 r44620  
    7474    Boost Authors</a></span></dt>
    7575<dd><dl>
     76<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.warnings">
     77      Disabling Compiler Warings</a></span></dt>
    7678<dt><span class="section"><a href="boost_config/guidelines_for_boost_authors.html#boost_config.guidelines_for_boost_authors.adding_new_defect_macros">Adding
    7779      New Defect Macros</a></span></dt>
     
    959961</div>
    960962<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    961 <td align="left"><p><small>Last revised: April 04, 2008 at 08:46:37 GMT</small></p></td>
     963<td align="left"><p><small>Last revised: April 20, 2008 at 12:51:56 GMT</small></p></td>
    962964<td align="right"><div class="copyright-footer"></div></td>
    963965</tr></table>
Note: See TracChangeset for help on using the changeset viewer.