updated the docs

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

docs/docs/api.xml

@@ -109,7 +109,7 @@
                            </item>
                            <item>
                                <name>message_box_blocking</name>
-                               <link>dlib/gui_widgets/widgets_abstract.h.html#message_box</link>
+                               <link>dlib/gui_widgets/widgets_abstract.h.html#message_box_blocking</link>
                            </item>
                            <item>
                                <name>open_file_box</name>

docs/docs/containers.xml

@@ -62,6 +62,7 @@
          <item>matrix</item> 
          <item>queue</item> 
          <item>reference_counter</item> 
+         <item>type_safe_union</item> 
          <item>sequence</item> 
          <item>set</item> 
          <item>stack</item> 
@@ -653,6 +654,27 @@
       
    <!-- ************************************************************************* -->
 
+      <component>
+         <name>type_safe_union</name>
+         <file>dlib/type_safe_union.h</file>
+         <spec_file link="true">dlib/type_safe_union/type_safe_union_kernel_abstract.h</spec_file>
+         <description>
+                This object is a type safe analogue of the classic C union object. 
+                The type_safe_union, unlike a union, can contain non-POD types such 
+                as std::string.    
+                <p>It is also implemented without performing any
+                   heap memory allocations and instead it stores everything on the stack.</p>
+         </description>
+         
+         <examples>
+            <example>pipe_ex_2.cpp.html</example>
+         </examples>
+         
+      </component>
+      
+   <!-- ************************************************************************* -->
+      
+
       <component>
          <name>shared_ptr_thread_safe</name>
          <file>dlib/smart_pointers_thread_safe.h</file>

docs/docs/main_menu.xml

@@ -203,6 +203,10 @@
                   <name>Pipe</name>
                   <link>pipe_ex.cpp.html</link>
                </item>
+               <item>
+                  <name>Pipe_2</name>
+                  <link>pipe_ex_2.cpp.html</link>
+               </item>
                <item>
                   <name>Timer</name>
                   <link>timer_ex.cpp.html</link>

docs/docs/other.xml

@@ -220,7 +220,7 @@
       </component>
       
    <!-- ************************************************************************* -->
-      
+
       <component>
          <name>pipe</name>
          <file>dlib/pipe.h</file>
@@ -232,6 +232,7 @@
          
          <examples>
             <example>pipe_ex.cpp.html</example>
+            <example>pipe_ex_2.cpp.html</example>
          </examples>
 
          <implementations>

docs/docs/release_notes.xml

@@ -13,12 +13,15 @@
 <current>
 New Stuff:
    - Added the multi-line text_box GUI widget.
+   - Added the type_safe_union object
 
 Non-Backwards Compatible Changes:
 
 Bug fixes:
 
 Other:
+   - Added an example showing how to use the type_safe_union and pipe
+     together.
 </current>
 
 <!-- *******************************************************************************  -->

docs/docs/term_index.xml

@@ -470,6 +470,7 @@
          <term link="containers.html#graph" name="graph"/>
          <term link="containers.html#directed_graph" name="directed_graph"/>
          <term link="containers.html#tuple" name="tuple"/>
+         <term link="containers.html#type_safe_union" name="type_safe_union"/>
          <term link="containers.html#array" name="array"/>
          <term link="containers.html#array2d" name="array2d"/>
          <term link="containers.html#binary_search_tree" name="binary_search_tree"/>