From: wolf Date: Fri, 1 Jul 2005 15:05:54 +0000 (+0000) Subject: Add docs. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=737d9fec141553f05db4b289398fa646e0b854f0;p=dealii-svn.git Add docs. git-svn-id: https://svn.dealii.org/trunk@11040 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/base/include/base/exceptions.h b/deal.II/base/include/base/exceptions.h index 83a7017f0c..325b7219ac 100644 --- a/deal.II/base/include/base/exceptions.h +++ b/deal.II/base/include/base/exceptions.h @@ -68,7 +68,7 @@ * this. * * Both modes use exception classes, which need to have special features - * additionally to the C++ standard's exception class. Such a class + * in additional to the C++ standard's exception class. Such a class * is declared by the following lines of code: * @code * DeclException2 (ExcDomain, int, int, @@ -146,14 +146,14 @@ * try to set this function to something reasonable, if the compiler * provides us with that, and "(not available)" otherwise. * - * In __IssueError the given data - * is transferred into the exc object by calling the - * set_fields() function; after that, the general error info - * is printed onto std::cerr using the PrintError() function of - * exc and finally the exception specific data is printed - * using the user defined function PrintError() (which is - * normally created using the DeclException (...) macro - * family. + * In __IssueError the given data is transferred into the + * exc object by calling the set_fields() function; after that, the + * general error info is printed onto std::cerr using the + * PrintError() function of exc and finally the exception specific + * data is printed using the user defined function PrintError() (which is + * normally created using the DeclException (...) macro family. If + * it can be obtained from the operating system, the output may also contain + * a stacktrace to show where the error happened. * * After printing all this information, * deal_II_exceptions::internals::abort() is called (with one @@ -244,16 +244,18 @@ * }; * @endcode * - * For this purpose, the macro AssertThrow was invented. It does mainly - * the same job as does the Assert macro, but it does not kill the - * program, it rather throws an exception as shown above. The mode of usage - * is + * For this purpose, the macro AssertThrow was invented. It does + * mainly the same job as does the Assert macro, but it does not + * kill the program, it rather throws an exception as shown above. The mode + * of usage is * @code * AssertThrow (cond, ExcSomething(additional information)); * @endcode + * * The condition to be checked is incorporated into the macro in order to * allow passing the violated condition as a string. The expansion of the - * AssertThrow macro is not affected by the DEBUG preprocessor variable. + * AssertThrow macro is not affected by the DEBUG + * preprocessor variable. * * * @section ExceptionNMacros Description of the DeclExceptionN macro family