updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402675

docs/docs/api.xml

@@ -611,6 +611,10 @@
                         <name>thread_pool</name>
                         <link>dlib/threads/thread_pool_extension_abstract.h.html#thread_pool</link>
                      </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>
@@ -1049,16 +1053,20 @@
 
             <extension>
                <name>thread_pool</name>
-               <spec_file>dlib/threads/thread_pool_extension_abstract.h</spec_file>
+               <spec_file link="true">dlib/threads/thread_pool_extension_abstract.h</spec_file>
                <description> 
                    <p>
                   This object represents a fixed size group of threads which you can
-                  submit tasks to and then wait for those tasks to be completed. 
+                  submit tasks to and then wait for those tasks to be completed.  It also
+                  provides a <a href="dlib/threads/thread_pool_extension_abstract.h.html#future">future</a> object
+                  that provides a container which allows you to safely pass objects into the tasks. 
                   </p>
                   The implementation of this extension can be found 
                   <a href="dlib/threads/thread_pool_extension.h.html">here</a>.  It is 
                   implemented such that no memory allocations occur after the thread pool
-                  has been constructed.
+                  has been constructed (the future object also doesn't perform any memory allocations or contain any system
+                  resources such as mutex objects).
+
                </description> 
 
                <examples>

docs/docs/index.xml

@@ -76,7 +76,7 @@
                   <li><a href="api.html#thread_specific_data">Thread specific data</a></li>
                   <li><a href="api.html#threaded_object">Threaded objects</a></li>
                   <li><a href="api.html#thread_function">Threaded functions</a></li>
-                  <li>A simple but powerful <a href="api.html#thread_pool">thread_pool</a></li>
+                  <li>A <a href="api.html#thread_pool">thread_pool</a> with support for futures</li>
                </ul>
             </li>
 

docs/docs/term_index.xml

@@ -25,6 +25,7 @@
          <term link="api.html#thread_specific_data" name="thread_specific_data"/>
          <term link="api.html#threaded_object" name="threaded_object"/>
          <term link="api.html#thread_pool" name="thread_pool"/>
+         <term link="api.html#thread_pool" name="futures"/>