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

updated the docs 

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403349
This commit is contained in:
Davis King 2010-01-03 19:58:03 +00:00
parent e8a859ce56
commit c9dc149453
2 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
docs/docs/api.xml
View File

@ -621,14 +621,26 @@
<name>rmutex</name>
<link>dlib/threads/rmutex_extension_abstract.h.html#rmutex</link>
</item>
<item>
<name>read_write_mutex</name>
<link>dlib/threads/read_write_mutex_extension_abstract.h.html#read_write_mutex</link>
</item>
<item>
<name>auto_mutex</name>
<link>dlib/threads/auto_mutex_extension_abstract.h.html#auto_mutex</link>
</item>
<item>
<name>auto_mutex_readonly</name>
<link>dlib/threads/auto_mutex_extension_abstract.h.html#auto_mutex_readonly</link>
</item>
<item>
<name>auto_unlock</name>
<link>dlib/threads/auto_unlock_extension_abstract.h.html#auto_unlock</link>
</item>
<item>
<name>auto_unlock_readonly</name>
<link>dlib/threads/auto_unlock_extension_abstract.h.html#auto_unlock_readonly</link>
</item>
<item>
<name>threaded_object</name>
<link>dlib/threads/threaded_object_extension_abstract.h.html#threaded_object</link>
@ -1020,6 +1032,21 @@
</description>
</extension>
<extension>
<name>read_write_mutex</name>
<spec_file>dlib/threads/read_write_mutex_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mutex object that can perform both normal "write locks" as well as "readonly locks".
See the specification for details.
Also note that this extension is included by dlib/threads.h so you don't have to include
anything extra to get it.
</p>
The implementation of this extension can be found
<a href="dlib/threads/read_write_mutex_extension.h.html">here</a>.
</description>
</extension>
<extension>
<name>create_new_thread extension</name>
<spec_file>dlib/threads/create_new_thread_extension_abstract.h</spec_file>
@ -1055,6 +1082,36 @@
</examples>
</extension>
<extension>
<name>auto_mutex_readonly</name>
<spec_file link="true">dlib/threads/auto_mutex_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mechanism to automatically perform a readonly lock and unlock
of a <a href="#read_write_mutex">read_write_mutex</a>.
Also note that this extension is included by dlib/threads.h so you don't have to include
anything extra to get it.
</p>
The implementation of this extension can be found
<a href="dlib/threads/auto_mutex_extension.h.html">here</a>.
</description>
</extension>
<extension>
<name>auto_unlock_readonly</name>
<spec_file link="true">dlib/threads/auto_unlock_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mechanism to automatically remove a readonly unlock from a <a href="#read_write_mutex">read_write_mutex</a>.
Also note that this extension is included by dlib/threads.h so you don't have to include
anything extra to get it.
</p>
The implementation of this extension can be found
<a href="dlib/threads/auto_unlock_extension.h.html">here</a>.
</description>
</extension>
<extension>
<name>thread_function</name>
<spec_file>dlib/threads/thread_function_extension_abstract.h</spec_file>

3
docs/docs/term_index.xml
View File

@ -394,9 +394,12 @@
<term file="api.html" name="threads"/>
<term file="api.html" name="auto_mutex"/>
<term file="api.html" name="auto_unlock"/>
<term file="api.html" name="auto_mutex_readonly"/>
<term file="api.html" name="auto_unlock_readonly"/>
<term link="api.html#create_new_thread%20extension" name="create_new_thread extension"/>
<term file="api.html" name="multithreaded_object"/>
<term file="api.html" name="rmutex"/>
<term file="api.html" name="read_write_mutex"/>
<term file="api.html" name="rsignaler"/>
<term file="api.html" name="thread_function"/>
<term file="api.html" name="thread_specific_data"/>