OrgLion-ML
/
dlib
mirror of https://github.com/davisking/dlib.git
1
0
Fork 0
Code Issues Releases Wiki Activity

updated docs

This commit is contained in:
Davis King 2016-08-28 12:07:39 -04:00
parent a670742273
commit 0ac2197c74
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs/metaprogramming.xml
View File

@ -630,8 +630,11 @@
<spec_file>dlib/assert.h</spec_file>
<description>
<p>
This is a macro function for debugging. Its form is <tt>DLIB_ASSERT(condition that should be
true,error message)</tt>. If the condition is false DLIB_ASSERT throws an exception of type
This is a macro function for debugging. Its form is
<code_box>DLIB_ASSERT(condition that should be true, error message)</code_box>
or you can omit the error message and call it like:
<code_box>DLIB_ASSERT(condition that should be true)</code_box>
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