From 0ac2197c7487e8ac4d4538e1c326e4b9343671e8 Mon Sep 17 00:00:00 2001 From: Davis King Date: Sun, 28 Aug 2016 12:07:39 -0400 Subject: [PATCH] updated docs --- docs/docs/metaprogramming.xml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/docs/metaprogramming.xml b/docs/docs/metaprogramming.xml index b1ef47a45..dc87f2c14 100644 --- a/docs/docs/metaprogramming.xml +++ b/docs/docs/metaprogramming.xml @@ -630,8 +630,11 @@ dlib/assert.h

- This is a macro function for debugging. Its form is DLIB_ASSERT(condition that should be - true,error message). If the condition is false DLIB_ASSERT throws an exception of type + This is a macro function for debugging. Its form is +DLIB_ASSERT(condition that should be true, error message) +or you can omit the error message and call it like: +DLIB_ASSERT(condition that should be true) + If the condition is false DLIB_ASSERT throws an exception of type dlib::fatal_error with fatal_error::type == EBROKEN_ASSERT. An error message detailing the nature of the problem is stored in the member variable info which is of type std::string. Look in the following file for more details. The exception classes are defined