Commit 46e17915 authored by Davis King's avatar Davis King

updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402863
parent 1c1730c1
...@@ -312,13 +312,14 @@ ...@@ -312,13 +312,14 @@
<a href="containers.html#queue">here</a>. <a href="containers.html#queue">here</a>.
</p> </p>
<p> <p>
None of the above applies to the API components (or any global functions or objects that don't list multiple implementations None of the above applies to the API components (or any global functions or objects that don't have an "implementations"
in their documentation). To use/create them you just need to include section in their documentation). To use/create them you just need to include
the appropriate headers. For example, to create a mutex object from the <a href="api.html#threads"> the appropriate headers. For example, to create a mutex object from the <a href="api.html#threads">
threads</a> component you would simply type <tt>dlib::mutex my_mutex;</tt>. There is no threads</a> component you would simply type <tt>dlib::mutex my_mutex;</tt>. There is no
need to specify which kernel implementation. The correct kernel implementation need to specify which kernel implementation. The correct kernel implementation
is determined by which platform you compile under. There are also no explicit checking versions is determined by which platform you compile under. There are also no explicit checking versions
of the API components. However, there are <a href="metaprogramming.html#DLIB_ASSERT">DLIB_ASSERT</a> statements that perform checking and you can of these components. However, there are
<a href="metaprogramming.html#DLIB_ASSERT">DLIB_ASSERT</a> statements that perform checking and you can
enable them by #defining DEBUG or ENABLE_ASSERTS. enable them by #defining DEBUG or ENABLE_ASSERTS.
</p> </p>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment