Skip to content

D
dlib
Commit aeaf6e87 authored by Davis King's avatar Davis King
Browse files
Options

updated docs

parent 446dcb43
Hide whitespace changes
Inline Side-by-side
Showing with 26 additions and 109 deletions
docs/docs/api.xml
View file @ aeaf6e87
......@@ -621,62 +621,24 @@
<item nolink="true">
<name>extensions</name>
<sub>
<item>
<name>thread_specific_data</name>
<link>dlib/threads/thread_specific_data_extension_abstract.h.html</link>
</item>
<item>
<name>create_new_thread extension</name>
<link>dlib/threads/create_new_thread_extension_abstract.h.html#create_new_thread</link>
</item>
<item>
<name>rsignaler</name>
<link>dlib/threads/rsignaler_extension_abstract.h.html#rsignaler</link>
</item>
<item>
<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>
</item>
<item>
<name>thread_pool</name>
<link>dlib/threads/thread_pool_extension_abstract.h.html#thread_pool</link>
</item>
<item>thread_specific_data</item>
<item>create_new_thread_extension</item>
<item>rsignaler</item>
<item>rmutex</item>
<item>read_write_mutex</item>
<item>auto_mutex</item>
<item>auto_mutex_readonly</item>
<item>auto_unlock</item>
<item>auto_unlock_readonly</item>
<item>threaded_object</item>
<item>thread_pool</item>
<item>parallel_for</item>
<item>
<name>future</name>
<link>dlib/threads/thread_pool_extension_abstract.h.html#future</link>
</item>
<item>
<name>thread_function</name>
<link>dlib/threads/thread_function_extension_abstract.h.html#thread_function</link>
</item>
<item>
<name>multithreaded_object</name>
<link>dlib/threads/multithreaded_object_extension_abstract.h.html#multithreaded_object</link>
</item>
<item>thread_function</item>
<item>multithreaded_object</item>
</sub>
</item>
<item>
......@@ -819,11 +781,7 @@
<name>dir_nav_extensions</name>
<spec_file>dlib/dir_nav/dir_nav_extensions_abstract.h</spec_file>
<description>
<p>
This is just some miscellaneous extensions to the dir_nav component.
</p>
The implementation of this extension can be found
<a href="dlib/dir_nav/dir_nav_extensions.h.html">here</a>.
</description>
</extension>
</extensions>
......@@ -951,11 +909,7 @@
<name>sockets_extensions</name>
<spec_file>dlib/sockets/sockets_extensions_abstract.h</spec_file>
<description>
<p>
This is just some miscellaneous extensions to the socket api.
</p>
The implementation of this extension can be found
<a href="dlib/sockets/sockets_extensions.h.html">here</a>.
</description>
</extension>
......@@ -1019,13 +973,9 @@
<name>rsignaler</name>
<spec_file>dlib/threads/rsignaler_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a signaler object that can be used with the rmutex object.
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/rsignaler_extension.h.html">here</a>.
</description>
</extension>
......@@ -1034,11 +984,7 @@
<name>thread_specific_data</name>
<spec_file>dlib/threads/thread_specific_data_extension_abstract.h</spec_file>
<description>
<p>
This extension adds the ability to easily create thread specific data.
</p>
The implementation of this extension can be found
<a href="dlib/threads/thread_specific_data_extension.h.html">here</a>.
</description>
</extension>
......@@ -1047,14 +993,10 @@
<name>rmutex</name>
<spec_file>dlib/threads/rmutex_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mutex object that can handle recursive calls
to lock().
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/rmutex_extension.h.html">here</a>.
</description>
</extension>
......@@ -1062,29 +1004,21 @@
<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>
<name>create_new_thread_extension</name>
<spec_file>dlib/threads/create_new_thread_extension_abstract.h</spec_file>
<description>
<p>
This extension adds some templated overloads to the
<a href="dlib/threads/threads_kernel_abstract.h.html#create_new_thread">create_new_thread()</a> function. They allow you to create new threads using member functions from a class.
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/create_new_thread_extension.h.html">here</a>.
</description>
......@@ -1094,13 +1028,9 @@
<name>auto_mutex</name>
<spec_file>dlib/threads/auto_mutex_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mechanism to automatically lock and unlock a mutex.
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>
<examples>
......@@ -1113,14 +1043,10 @@
<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>
......@@ -1128,13 +1054,9 @@
<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>
......@@ -1142,12 +1064,8 @@
<name>thread_function</name>
<spec_file>dlib/threads/thread_function_extension_abstract.h</spec_file>
<description>
<p>
This object represents a thread on a global C++ function. That is, it allows you
to run a global function in its own thread.
</p>
The implementation of this extension can be found
<a href="dlib/threads/thread_function_extension.h.html">here</a>.
</description>
<examples>
......@@ -1161,12 +1079,8 @@
<name>threaded_object</name>
<spec_file>dlib/threads/threaded_object_extension_abstract.h</spec_file>
<description>
<p>
This extension represents a simple threaded object. It provides a convenient
mechanism to create an object that contains a thread.
</p>
The implementation of this extension can be found
<a href="dlib/threads/threaded_object_extension.h.html">here</a>.
</description>
<examples>
......@@ -1199,17 +1113,22 @@
</examples>
</extension>
<extension>
<name>parallel_for</name>
<spec_file>dlib/threads/parallel_for_extension_abstract.h</spec_file>
<description>
This is a set of functions for executing the contents of a for loop in parallel.
It is useful for taking advantage of multi-processor systems.
</description>
</extension>
<extension>
<name>multithreaded_object</name>
<spec_file>dlib/threads/multithreaded_object_extension_abstract.h</spec_file>
<description>
<p>
This object represents a multithreaded object. It is similar to
the <a href="#threaded_object">threaded_object</a> except it allows you to have many threads in a
single object rather than just one.
</p>
The implementation of this extension can be found
<a href="dlib/threads/multithreaded_object_extension.h.html">here</a>.
</description>
<examples>
......@@ -1222,13 +1141,9 @@
<name>auto_unlock</name>
<spec_file>dlib/threads/auto_unlock_extension_abstract.h</spec_file>
<description>
<p>
This extension adds a mechanism to automatically unlock a mutex.
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>
......
docs/docs/term_index.xml
View file @ aeaf6e87
......@@ -693,6 +693,8 @@
<term file="api.html" name="thread_specific_data"/>
<term file="api.html" name="threaded_object"/>
<term file="api.html" name="thread_pool"/>
<term file="api.html" name="parallel_for"/>
<term link="api.html#parallel_for" name="parallel_for_blocked"/>
<term link="api.html#thread_pool" name="futures"/>
......
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