From ca68fc8053014ce5c9d951c90be60bc29f5e9f17 Mon Sep 17 00:00:00 2001
From: Davis King <davis@dlib.net>
Date: Mon, 8 Dec 2014 20:35:13 -0500
Subject: [PATCH] updated docs

---
 docs/docs/imaging.xml        | 19 +++++++++++++++++++
 docs/docs/linear_algebra.xml | 28 ++++++++++++++++++++++++++++
 docs/docs/term_index.xml     |  3 +++
 3 files changed, 50 insertions(+)

diff --git a/docs/docs/imaging.xml b/docs/docs/imaging.xml
index 42ca3b0bb..601266aef 100644
--- a/docs/docs/imaging.xml
+++ b/docs/docs/imaging.xml
@@ -240,6 +240,7 @@
          <item>zero_border_pixels</item> 
          <item>integral_image</item>
          <item>integral_image_generic</item>
+         <item>hough_transform</item>
 
       </section>
 
@@ -252,6 +253,24 @@
 
    <components>
    
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>hough_transform</name>
+         <file>dlib/image_transforms.h</file>
+         <spec_file link="true">dlib/image_transforms/hough_transform_abstract.h</spec_file>
+         <description>
+                This object is a tool for computing the line finding version of
+                the Hough transform given some kind of edge detection image as
+                input.  It also allows the edge pixels to be weighted such that
+                higher weighted edge pixels contribute correspondingly more to
+                the output of the Hough transform, allowing stronger edges to
+                create correspondingly stronger line detections in the final
+                Hough transform.
+         </description>
+                                 
+      </component>
+
    <!-- ************************************************************************* -->
       
       <component>
diff --git a/docs/docs/linear_algebra.xml b/docs/docs/linear_algebra.xml
index 3b804b101..9454db5fc 100644
--- a/docs/docs/linear_algebra.xml
+++ b/docs/docs/linear_algebra.xml
@@ -620,6 +620,8 @@
          <item>move_rect</item> 
          <item>nearest_point</item> 
          <item>distance_to_rect_edge</item> 
+         <item>clip_line_to_rectangle</item> 
+         <item>distance_to_line</item> 
       </section>
 
 
@@ -857,6 +859,32 @@
                                  
       </component>
 
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>distance_to_line</name>
+         <file>dlib/geometry.h</file>
+         <spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
+         <description>        
+            This function takes a line and a <a href="#point">point</a>
+            and returns the distance from the line to the point.  
+         </description>
+                                 
+      </component>
+
+   <!-- ************************************************************************* -->
+
+      <component>
+         <name>clip_line_to_rectangle</name>
+         <file>dlib/geometry.h</file>
+         <spec_file link="true">dlib/geometry/rectangle_abstract.h</spec_file>
+         <description>        
+            This function takes a <a href="#rectangle">rectangle</a> and a line segment and
+            returns the part of the line segment that is entirely contained within the
+            rectangle.
+         </description>
+      </component>
+
    <!-- ************************************************************************* -->
 
       <component>
diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml
index 8f02eb0b2..b6ebfa966 100644
--- a/docs/docs/term_index.xml
+++ b/docs/docs/term_index.xml
@@ -47,6 +47,8 @@
          <term file="linear_algebra.html" name="center" include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="nearest_point" include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="distance_to_rect_edge" include="dlib/geometry.h"/>
+         <term file="linear_algebra.html" name="distance_to_line" include="dlib/geometry.h"/>
+         <term file="linear_algebra.html" name="clip_line_to_rectangle" include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="shrink_rect" include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="grow_rect" include="dlib/geometry.h"/>
          <term file="linear_algebra.html" name="dcenter" include="dlib/geometry.h"/>
@@ -1284,6 +1286,7 @@
 
          <term file="imaging.html" name="integral_image"          include="dlib/image_transforms.h"/>
          <term file="imaging.html" name="integral_image_generic"  include="dlib/image_transforms.h"/>
+         <term file="imaging.html" name="hough_transform"         include="dlib/image_transforms.h"/>
          <term file="imaging.html" name="hessian_pyramid"         include="dlib/image_keypoint.h"/>
          <term file="imaging.html" name="compute_dominant_angle"  include="dlib/image_keypoint.h"/>
          <term file="imaging.html" name="draw_surf_points"        include="dlib/image_keypoint/draw_surf_points.h"/>