updated docs

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

docs/docs/imaging.xml

@@ -77,6 +77,7 @@
 
          <item>draw_line</item> 
          <item>assign_image</item> 
+         <item>assign_image_scaled</item> 
          <item>assign_all_pixels</item> 
          <item>assign_border_pixels</item> 
          <item>equalize_histogram</item> 
@@ -569,6 +570,21 @@
                                  
       </component>
             
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>assign_image_scaled</name>
+         <file>dlib/image_transforms.h</file>
+         <spec_file link="true">dlib/image_transforms/assign_image_abstract.h</spec_file>
+         <description>        
+            This global function copies one image into another and performs any
+            necessary color space conversions to make it work right.  Additionally,
+            if the dynamic range of the source and destination images is not the same
+            then it will attempt to perform the appropriate scaling.
+         </description>
+                                 
+      </component>
+            
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/metaprogramming.xml

@@ -48,6 +48,7 @@
          <item>is_std_vector</item>
          <item>is_directed_graph</item>
          <item>is_built_in_scalar_type</item>
+         <item>promote</item>
          <item>unsigned_type</item> 
          <item>tabs</item> 
          <item>tmin</item> 
@@ -301,6 +302,24 @@
          
       </component>
       
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>promote</name>
+         <file>dlib/algs.h</file>
+         <spec_file link="true">dlib/algs.h</spec_file>
+         <description>
+        This is a template that takes one of the built in scalar types and give you another
+        scalar type that should be big enough to hold sums of values from the original scalar 
+        type.  The new scalar type will also always be signed.
+
+         <p>
+        For example, promote&lt;uint16&gt;::type == int32
+         </p>
+         </description>
+         
+      </component>
+      
    <!-- ************************************************************************* -->
       
       

docs/docs/term_index.xml

@@ -408,6 +408,7 @@
          <term file="metaprogramming.html" name="is_std_vector"/>
          <term file="metaprogramming.html" name="is_directed_graph"/>
          <term file="metaprogramming.html" name="is_built_in_scalar_type"/>
+         <term file="metaprogramming.html" name="promote"/>
          <term file="metaprogramming.html" name="assign_zero_if_built_in_scalar_type"/>
 
 
@@ -847,6 +848,7 @@
     
 
          <term file="imaging.html" name="assign_image"/>
+         <term file="imaging.html" name="assign_image_scaled"/>
          <term file="imaging.html" name="assign_all_pixels"/>
          <term file="imaging.html" name="assign_border_pixels"/>
          <term file="imaging.html" name="assign_pixel"/>