boostorg/exception
1
0
Fork 1
mirror of https://github.com/boostorg/exception.git synced 2025-07-15 21:42:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

documentation update

Browse Source 
[SVN r54870]
This commit is contained in:
Emil Dotchevski
2009-07-10 19:03:29 +00:00
parent 96e2ac573a
commit 96ed20d2d7
17 changed files with 8748 additions and 8695 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/boost_exception_errinfo_api_function_hpp.html
View File

@ -32,7 +32,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_api_function.html">errinfo_api_function<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_at_line_hpp.html
View File

@ -32,7 +32,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_at_line.html">errinfo_at_line<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_errno_hpp.html
View File

@ -33,7 +33,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_errno.html">errinfo_errno<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_file_handle_hpp.html
View File

@ -33,7 +33,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_file_handle.html">errinfo_file_handle<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_file_name_hpp.html
View File

@ -33,7 +33,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_file_name.html">errinfo_file_name<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_file_open_mode_hpp.html
View File

@ -33,7 +33,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_file_open_mode.html">errinfo_file_open_mode<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

1
doc/boost_exception_errinfo_type_info_name_hpp.html
View File

@ -33,7 +33,6 @@ boost
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_all_hpp.html">boost/exception/all.hpp<br/>
</a><a href="errinfo_type_info_name.html">errinfo_type_info_name<br/>
</a><a href="synopsis.html">Synopsis<br/>
</a></div>
</div>

6
doc/boost_exception_exception_hpp.html
View File

@ -38,9 +38,9 @@ boost
<span class="RenoIncludeSPAN">template &lt;class Tag,class T&gt;
class <span class="RenoLink"><a href="error_info.html">error_info</a></span>;</span>
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_function,char const *&gt; throw_function;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_file,char const *&gt; throw_file;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_line,int&gt; throw_line;</span>
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_function_,char const *&gt; throw_function;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_file_,char const *&gt; throw_file;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_line_,int&gt; throw_line;</span>
}</pre>
</div></div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>

1
doc/errinfo_api_function.html
View File

@ -33,6 +33,7 @@ boost
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_errinfo_api_function_hpp.html">boost/exception/errinfo_api_function.hpp<br/>
</a><a href="frequently_asked_questions.html">Frequently Asked Questions<br/>
</a></div>
</div>
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->

1
doc/errinfo_errno.html
View File

@ -34,6 +34,7 @@ boost
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_errinfo_errno_hpp.html">boost/exception/errinfo_errno.hpp<br/>
</a><a href="frequently_asked_questions.html">Frequently Asked Questions<br/>
</a></div>
</div>
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->

1
doc/errinfo_file_name.html
View File

@ -34,6 +34,7 @@ boost
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_errinfo_file_name_hpp.html">boost/exception/errinfo_file_name.hpp<br/>
</a><a href="frequently_asked_questions.html">Frequently Asked Questions<br/>
</a></div>
</div>
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->

1
doc/errinfo_file_open_mode.html
View File

@ -34,6 +34,7 @@ boost
</div><div class="RenoAutoDIV"><div class="RenoHR"><hr/></div>
<h3>See Also:</h3>
<div class="RenoPageList"><a href="boost_exception_errinfo_file_open_mode_hpp.html">boost/exception/errinfo_file_open_mode.hpp<br/>
</a><a href="frequently_asked_questions.html">Frequently Asked Questions<br/>
</a></div>
</div>
<!-- Copyright (c) 2006-2009 Emil Dotchevski and Reverge Studios, Inc. -->

16
doc/error_info.html
View File

@ -59,6 +59,15 @@ typedef boost::<span class="RenoLink">error_info</span>&lt;struct tag_errno,int&
if( int const * e=boost::<span class="RenoLink"><a href="get_error_info.html">get_error_info</a></span>&lt;errno_info&gt;(x) )
....
}</pre>
<p>For convenience and uniformity, Boost Exception defines the following commonly used <span class="RenoLink">error_info</span> typedefs, ready for use with <span class="RenoLink"><a href="exception_operator_shl.html">operator&lt;&lt;</a></span>:</p>
<div class="RenoPageList"><a href="errinfo_api_function.html">errinfo_api_function<br/>
</a><a href="errinfo_at_line.html">errinfo_at_line<br/>
</a><a href="errinfo_errno.html">errinfo_errno<br/>
</a><a href="errinfo_file_handle.html">errinfo_file_handle<br/>
</a><a href="errinfo_file_name.html">errinfo_file_name<br/>
</a><a href="errinfo_file_open_mode.html">errinfo_file_open_mode<br/>
</a><a href="errinfo_type_info_name.html">errinfo_type_info_name<br/>
</a></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/>
@ -66,13 +75,6 @@ typedef boost::<span class="RenoLink">error_info</span>&lt;struct tag_errno,int&
</a><a href="boost_exception_exception_hpp.html">boost/exception/exception.hpp<br/>
</a><a href="boost_exception_info_hpp.html">boost/exception/info.hpp<br/>
</a><a href="diagnostic_information.html">diagnostic_information<br/>
</a><a href="errinfo_api_function.html">errinfo_api_function<br/>
</a><a href="errinfo_at_line.html">errinfo_at_line<br/>
</a><a href="errinfo_errno.html">errinfo_errno<br/>
</a><a href="errinfo_file_handle.html">errinfo_file_handle<br/>
</a><a href="errinfo_file_name.html">errinfo_file_name<br/>
</a><a href="errinfo_file_open_mode.html">errinfo_file_open_mode<br/>
</a><a href="errinfo_type_info_name.html">errinfo_type_info_name<br/>
</a><a href="error_info_error_info.html">error_info::error_info<br/>
</a><a href="error_info_value.html">error_info::value<br/>
</a><a href="error_info_value_type.html">error_info::value_type<br/>

12
doc/frequently_asked_questions.html
View File

@ -53,13 +53,13 @@ catch( ... )
std::cerr &lt;&lt; "OMG!!!";
}</pre>
<p>This is a possible message it may display, the first line is only possible if <span class="RenoLink"><a href="BOOST_THROW_EXCEPTION.html">BOOST_THROW_EXCEPTION</a></span> is used:</p>
<pre>example_io.cpp(83): Throw in function void parse_file(const char *)
Dynamic exception type: class file_open_error
<pre>example_io.cpp(70): Throw in function class boost::shared_ptr&lt;struct _iobuf&gt; __cdecl my_fopen(const char *,const char *)
Dynamic exception type: class boost::exception_detail::clone_impl&lt;class fopen_error&gt;
std::exception::what: example_io error
[struct tag_errno_code *] = 2, OS says "No such file or directory"
[struct tag_file_name *] = tmp1.xml
[struct tag_function *] = fopen
[struct tag_open_mode *] = rb</pre>
[struct boost::<span class="RenoLink"><a href="errinfo_api_function.html">errinfo_api_function</a></span>_ *] = fopen
[struct boost::<span class="RenoLink"><a href="errinfo_errno.html">errinfo_errno</a></span>_ *] = 2, "No such file or directory"
[struct boost::<span class="RenoLink"><a href="errinfo_file_name.html">errinfo_file_name</a></span>_ *] = tmp1.txt
[struct boost::<span class="RenoLink"><a href="errinfo_file_open_mode.html">errinfo_file_open_mode</a></span>_ *] = rb</pre>
<h3>Why is boost::exception integrated in boost::throw_exception?</h3>
<p>The boost::<span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span> function predates the Boost Exception library and there has been some concern about its current behavior of injecting boost::<span class="RenoLink"><a href="exception.html">exception</a></span> as a base of any exception passed to boost::<span class="RenoLink"><a href="throw_exception.html">throw_exception</a></span>. Such concerns are dictated by the typical strict interpretation of a common principle in C and C++, that users only pay for features they actually use.</p>
<p>The problem is that users of Boost Exception can't by themselves cause a library to throw types that derive from boost::<span class="RenoLink"><a href="exception.html">exception</a></span>, and without this they can't use any of the Boost Exception facilities.</p>

17414
doc/source/boost-exception.reno
View File

File diff suppressed because it is too large Load Diff

6
doc/synopsis.html
View File

@ -38,9 +38,9 @@ boost
<span class="RenoIncludeSPAN">template &lt;class Tag,class T&gt;
class <span class="RenoLink"><a href="error_info.html">error_info</a></span>;</span>
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_function,char const *&gt; throw_function;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_file,char const *&gt; throw_file;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct tag_throw_line,int&gt; throw_line;</span>
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_function_,char const *&gt; throw_function;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_file_,char const *&gt; throw_file;
typedef <span class="RenoLink"><a href="error_info.html">error_info</a></span>&lt;struct throw_line_,int&gt; throw_line;</span>
}</span></pre>
<p><span class="RenoEscape">&#35;<!--<wiki>`&#35;</wiki>--></span>include &lt;<span class="RenoLink"><a href="boost_exception_error_info_hpp.html">boost/exception/error_info.hpp</a></span>&gt;</p>
<pre><span class="RenoIncludeSPAN">namespace

12
include/boost/exception/exception.hpp
View File

@ -80,13 +80,13 @@ boost
template <class Tag,class T>
class error_info;
typedef error_info<struct tag_throw_function,char const *> throw_function;
typedef error_info<struct tag_throw_file,char const *> throw_file;
typedef error_info<struct tag_throw_line,int> throw_line;
typedef error_info<struct throw_function_,char const *> throw_function;
typedef error_info<struct throw_file_,char const *> throw_file;
typedef error_info<struct throw_line_,int> throw_line;
template <>
class
error_info<tag_throw_function,char const *>
error_info<throw_function_,char const *>
{
public:
typedef char const * value_type;
@ -100,7 +100,7 @@ boost
template <>
class
error_info<tag_throw_file,char const *>
error_info<throw_file_,char const *>
{
public:
typedef char const * value_type;
@ -114,7 +114,7 @@ boost
template <>
class
error_info<tag_throw_line,int>
error_info<throw_line_,int>
{
public:
typedef int value_type;