make doc++ able to generate the source documentation for lyx

[lyx.git] / src / support / LAssert.h

diff --git a/src/support/LAssert.h b/src/support/LAssert.h
index 071f50919d85234c9d465f88a3b74de6e4fc0b75..a62e16b3435a474b94fa194bdaec419fd45f2f26 100644 (file)
--- a/src/support/LAssert.h
+++ b/src/support/LAssert.h
@@ -8,19 +8,33 @@
 
 #ifdef ENABLE_ASSERTIONS
 
-template<class A> inline void Assert(A assertion)
+extern void emergencySave();
+
+/** Live assertion.
+    This is a debug tool to ensure that the assertion holds. If it don't hole
+    we run #emergencySave()# and then #lyx::abort".
+    @param assertion this should evaluate to true unless you want an abort.
+*/
+template<class A>
+inline
+void Assert(A assertion)
 {
        if (!assertion) {
+               ::emergencySave();
                lyx::abort();
        }
 }
 
 #else
 
-template<class A> inline void Assert(A /*assertion*/) {}
+/** Dummy assertion.
+    When compiling without assertions we use this no-op function.
+*/
+template<class A>
+inline
+void Assert(A /*assertion*/) {}
 
 #endif /* ENABLE_ASSERTIONS */
 
 //} // end of namespace LyX
 #endif /* LASSERT_H */
-