From: Wolfgang Bangerth <bangerth@math.tamu.edu>
Date: Tue, 31 May 2016 23:09:38 +0000 (-0500)
Subject: Centralize the place where we generate documentation about exception messages.
X-Git-Tag: v8.5.0-rc1~993^2
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F2660%2Fhead;p=dealii.git

Centralize the place where we generate documentation about exception messages.
---

diff --git a/doc/doxygen/options.dox.in b/doc/doxygen/options.dox.in
index 8faf11feda..67890cf736 100644
--- a/doc/doxygen/options.dox.in
+++ b/doc/doxygen/options.dox.in
@@ -83,6 +83,7 @@ ALIASES += dealiiRequiresUpdateFlags{1}="@note For this function to work properl
 
 ALIASES += dealiiOperationIsMultithreaded="@note If deal.II is configured with threads, this operation will run multi-threaded by splitting the work into smaller chunks (assuming there is enough work to make this worthwhile)."
 
+ALIASES += dealiiExceptionMessage{1}="@note The message that will be printed by this exception reads: @code \1 @endcode"
 
 #---------------------------------------------------------------------------
 # configuration options related to source browsing
diff --git a/include/deal.II/base/exceptions.h b/include/deal.II/base/exceptions.h
index 40288f8267..fdad1604d4 100644
--- a/include/deal.II/base/exceptions.h
+++ b/include/deal.II/base/exceptions.h
@@ -533,7 +533,7 @@ namespace deal_II_exceptions
  */
 #define DeclExceptionMsg(Exception, defaulttext)                          \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code defaulttext @endcode */  \
+  /** @dealiiExceptionMessage{defaulttext} */  \
   static dealii::ExceptionBase& Exception ()
 
 /**
@@ -544,7 +544,7 @@ namespace deal_II_exceptions
  */
 #define DeclException1(Exception1, type1, outsequence)                    \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code outsequence @endcode */              \
+  /** @dealiiExceptionMessage{outsequence} */              \
   static dealii::ExceptionBase& Exception1 (type1 arg1)
 
 
@@ -556,7 +556,7 @@ namespace deal_II_exceptions
  */
 #define DeclException2(Exception2, type1, type2, outsequence)             \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code outsequence @endcode */              \
+  /** @dealiiExceptionMessage{outsequence} */              \
   static dealii::ExceptionBase& Exception2 (type1 arg1, type2 arg2)
 
 
@@ -568,7 +568,7 @@ namespace deal_II_exceptions
  */
 #define DeclException3(Exception3, type1, type2, type3, outsequence)      \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code outsequence @endcode */              \
+  /** @dealiiExceptionMessage{outsequence} */              \
   static dealii::ExceptionBase& Exception3 (type1 arg1, type2 arg2, type3 arg3)
 
 
@@ -580,7 +580,7 @@ namespace deal_II_exceptions
  */
 #define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code outsequence @endcode */                \
+  /** @dealiiExceptionMessage{outsequence} */                \
   static dealii::ExceptionBase& Exception4 (type1 arg1, type2 arg2, type3 arg3, type4 arg4)
 
 
@@ -592,7 +592,7 @@ namespace deal_II_exceptions
  */
 #define DeclException5(Exception5, type1, type2, type3, type4, type5, outsequence) \
   /** @ingroup Exceptions */ \
-  /** @note The error text is: @code outsequence @endcode */                       \
+  /** @dealiiExceptionMessage{outsequence} */                       \
   static dealii::ExceptionBase& Exception5 (type1 arg1, type2 arg2, type3 arg3, type4 arg4, type5 arg5)
 
 #endif /*ifndef DOXYGEN*/