forked from boostorg/config
Document BOOST_PRAGMA_MESSAGE header; fix mentions of detail/workaround.hpp
This commit is contained in:
@@ -3968,7 +3968,7 @@
|
|||||||
that is not otherwise described by one of the other Boost.Config
|
that is not otherwise described by one of the other Boost.Config
|
||||||
macros. To use the macro you must first
|
macros. To use the macro you must first
|
||||||
</p>
|
</p>
|
||||||
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">detail</span><span class="special">/</span><span class="identifier">workaround</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">workaround</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
|
||||||
</pre>
|
</pre>
|
||||||
<p>
|
<p>
|
||||||
usage is then:
|
usage is then:
|
||||||
@@ -3999,7 +3999,7 @@
|
|||||||
</p>
|
</p>
|
||||||
<p>
|
<p>
|
||||||
<span class="bold"><strong>Note</strong></span>: the ultimate source of documentation
|
<span class="bold"><strong>Note</strong></span>: the ultimate source of documentation
|
||||||
for this macro is in <a href="../../../../../boost/detail/workaround.hpp" target="_top">boost/detail/workaround.hpp</a>.
|
for this macro is in <a href="../../../../../boost/config/workaround.hpp" target="_top">boost/config/workaround.hpp</a>.
|
||||||
</p>
|
</p>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
@@ -4551,7 +4551,8 @@
|
|||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<p>
|
<p>
|
||||||
Expands to the equivalent of <code class="computeroutput"><span class="preprocessor">#pragma</span>
|
Defined in header <code class="computeroutput"><span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">config</span><span class="special">/</span><span class="identifier">pragma_message</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code>,
|
||||||
|
this macro expands to the equivalent of <code class="computeroutput"><span class="preprocessor">#pragma</span>
|
||||||
<span class="identifier">message</span><span class="special">(</span><span class="identifier">M</span><span class="special">)</span></code>.
|
<span class="identifier">message</span><span class="special">(</span><span class="identifier">M</span><span class="special">)</span></code>.
|
||||||
<code class="computeroutput"><span class="identifier">M</span></code> must be a string
|
<code class="computeroutput"><span class="identifier">M</span></code> must be a string
|
||||||
literal. Example: <code class="computeroutput"><span class="identifier">BOOST_PRAGMA_MESSAGE</span><span class="special">(</span><span class="string">"This header
|
literal. Example: <code class="computeroutput"><span class="identifier">BOOST_PRAGMA_MESSAGE</span><span class="special">(</span><span class="string">"This header
|
||||||
|
@@ -992,7 +992,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
|
||||||
<td align="left"><p><small>Last revised: December 03, 2017 at 22:51:50 GMT</small></p></td>
|
<td align="left"><p><small>Last revised: December 03, 2017 at 23:12:48 GMT</small></p></td>
|
||||||
<td align="right"><div class="copyright-footer"></div></td>
|
<td align="right"><div class="copyright-footer"></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
<hr>
|
<hr>
|
||||||
|
@@ -979,7 +979,7 @@ workarounds for compiler/standard library defects.
|
|||||||
This macro is used where a compiler specific workaround is required that is not otherwise
|
This macro is used where a compiler specific workaround is required that is not otherwise
|
||||||
described by one of the other Boost.Config macros. To use the macro you must first
|
described by one of the other Boost.Config macros. To use the macro you must first
|
||||||
``
|
``
|
||||||
#include <boost/detail/workaround.hpp>
|
#include <boost/config/workaround.hpp>
|
||||||
``
|
``
|
||||||
usage is then:
|
usage is then:
|
||||||
``
|
``
|
||||||
@@ -1001,7 +1001,7 @@ For example
|
|||||||
of `__BORLANDC__` /unless/ the macro `BOOST_DETECT_OUTDATED_WORKAROUNDS` is defined, in which case evaluates to
|
of `__BORLANDC__` /unless/ the macro `BOOST_DETECT_OUTDATED_WORKAROUNDS` is defined, in which case evaluates to
|
||||||
`(__BORLANDC__ <= 0x590)`.
|
`(__BORLANDC__ <= 0x590)`.
|
||||||
|
|
||||||
[*Note]: the ultimate source of documentation for this macro is in [@../../../../boost/detail/workaround.hpp boost/detail/workaround.hpp].
|
[*Note]: the ultimate source of documentation for this macro is in [@../../../../boost/config/workaround.hpp boost/config/workaround.hpp].
|
||||||
]]
|
]]
|
||||||
[[`BOOST_PREVENT_MACRO_SUBSTITUTION`][
|
[[`BOOST_PREVENT_MACRO_SUBSTITUTION`][
|
||||||
Sometimes you have a function name with the same name as a C macro, for example "min" and "max"
|
Sometimes you have a function name with the same name as a C macro, for example "min" and "max"
|
||||||
@@ -1279,8 +1279,9 @@ Usage example:
|
|||||||
typedef unsigned int BOOST_MAY_ALIAS aliasing_uint;
|
typedef unsigned int BOOST_MAY_ALIAS aliasing_uint;
|
||||||
``
|
``
|
||||||
]]
|
]]
|
||||||
[[`BOOST_PRAGMA_MESSAGE(M)`][Expands to the equivalent of `#pragma message(M)`. `M` must
|
[[`BOOST_PRAGMA_MESSAGE(M)`][Defined in header `<boost/config/pragma_message.hpp>`,
|
||||||
be a string literal. Example: `BOOST_PRAGMA_MESSAGE("This header is deprecated.")`.]]
|
this macro expands to the equivalent of `#pragma message(M)`. `M` must be a string
|
||||||
|
literal. Example: `BOOST_PRAGMA_MESSAGE("This header is deprecated.")`.]]
|
||||||
]
|
]
|
||||||
|
|
||||||
[endsect]
|
[endsect]
|
||||||
|
Reference in New Issue
Block a user