mirror of
https://github.com/boostorg/exception.git
synced 2025-07-29 20:17:20 +02:00
boost exception documentation update
[SVN r48471]
This commit is contained in:
@ -25,12 +25,15 @@
|
||||
<pre>namespace
|
||||
boost
|
||||
{
|
||||
<span class="RenoIncludeSPAN"> std::string <span class="RenoLink"><a href="diagnostic_information.html">diagnostic_information</a></span>( std::exception const & x );</span>
|
||||
<span class="RenoIncludeSPAN"> template <class T>
|
||||
std::string <span class="RenoLink"><a href="diagnostic_information.html">diagnostic_information</a></span>( T const & x );</span>
|
||||
}</pre>
|
||||
</div><h4>Requirements:</h4>
|
||||
<p>The <span class="RenoLink"><a href="diagnostic_information.html">diagnostic_information</a></span> function must not be called outside of a catch block.</p>
|
||||
<h4>Returns:</h4>
|
||||
<p>If dynamic_cast<boost::<span class="RenoLink"><a href="exception.html">exception</a></span> const *>(&x) is not null, the returned string is initialized by a call to <span class="RenoLink"><a href="exception_diagnostic_information.html">exception::diagnostic_information</a></span>; otherwise, the returned string combines the output of x.what() and typeid(x).name().</p>
|
||||
</div><h4>Returns:</h4>
|
||||
<p>Platform-specific diagnostic information about x.</p>
|
||||
<h4>Notes:</h4>
|
||||
<div><ul><li>If dynamic_cast<std::exception const *>(&x) is not null, the returned string includes the output from std::exception::what.</li>
|
||||
<li>If dynamic_cast<boost::<span class="RenoLink"><a href="exception.html">exception</a></span> const *>(&x) is not null, the returned string includes the output from boost::<span class="RenoLink"><a href="exception_diagnostic_information.html">exception::diagnostic_information</a></span>.</li>
|
||||
</ul></div>
|
||||
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
|
||||
<h3>See Also:</h3>
|
||||
<div class="RenoPageList"><a href="boost-exception.html">Boost Exception<br/>
|
||||
|
Reference in New Issue
Block a user