updated docs

This commit is contained in:
Davis King 2011-05-28 17:24:30 -04:00
parent 5b2228e07c
commit 4369c68376
2 changed files with 23 additions and 0 deletions

View File

@ -66,6 +66,7 @@
<item>DLIB_CASSERT</item>
<item>COMPILE_TIME_ASSERT</item>
<item>ASSERT_ARE_SAME_TYPE</item>
<item>DLIB_ASSERT_HAS_STANDARD_LAYOUT</item>
<item>ASSERT_ARE_NOT_SAME_TYPE</item>
<item>_dT</item>
<item>TIME_THIS</item>
@ -480,6 +481,27 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>DLIB_ASSERT_HAS_STANDARD_LAYOUT</name>
<file>dlib/assert.h</file>
<spec_file link="true">dlib/assert.h</spec_file>
<description>
<p>
This macro is meant to cause a compiler error if a type doesn't have a simple
memory layout (like a C struct). In particular, types with simple layouts are
ones which can be copied via memcpy().
</p>
This was called a POD type in C++03 and in C++0x we are looking to check if
it is a "standard layout type". Once we can use C++0x we can change this macro
to something that uses the std::is_standard_layout type_traits class.
See: http://www2.research.att.com/~bs/C++0xFAQ.html#PODs
</description>
</component>
<!-- ************************************************************************* -->
<component>

View File

@ -438,6 +438,7 @@
<term file="metaprogramming.html" name="ASSERT_ARE_SAME_TYPE"/>
<term file="metaprogramming.html" name="DLIB_CASSERT"/>
<term file="metaprogramming.html" name="COMPILE_TIME_ASSERT"/>
<term file="metaprogramming.html" name="DLIB_ASSERT_HAS_STANDARD_LAYOUT"/>
<term file="metaprogramming.html" name="TIME_THIS"/>
<term link="metaprogramming.html#TIME_THIS" name="TIME_THIS_TO"/>
<term file="metaprogramming.html" name="_dT"/>