From 743985a1afeb76e98cfbf6e0127227ebed91d0df Mon Sep 17 00:00:00 2001
From: Davis King <davis@dlib.net>
Date: Sun, 26 Dec 2010 16:54:54 +0000
Subject: [PATCH] updated docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%404033
---
 docs/docs/containers.xml | 15 +++++++++++++++
 docs/docs/term_index.xml |  1 +
 2 files changed, 16 insertions(+)

diff --git a/docs/docs/containers.xml b/docs/docs/containers.xml
index 2f81f0d2d..98901d3a4 100644
--- a/docs/docs/containers.xml
+++ b/docs/docs/containers.xml
@@ -552,6 +552,7 @@
          <item>queue</item> 
          <item>reference_counter</item> 
          <item>type_safe_union</item> 
+         <item>unordered_pair</item> 
          <item>sequence</item> 
          <item>set</item> 
          <item>stack</item> 
@@ -1162,6 +1163,20 @@
          
       </component>
       
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>unordered_pair</name>
+         <file>dlib/unordered_pair.h</file>
+         <spec_file link="true">dlib/unordered_pair.h</spec_file>
+         <description>
+                This object is very similar to the std::pair struct except unordered_pair 
+                is only capable of representing an unordered set of two items rather than 
+                an ordered list of two items like std::pair.  
+         </description>
+         
+      </component>
+      
    <!-- ************************************************************************* -->
       
       <component>
diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml
index fb1dd3664..9a98d6e51 100644
--- a/docs/docs/term_index.xml
+++ b/docs/docs/term_index.xml
@@ -233,6 +233,7 @@
          <term link="dlib/svm/kernel_abstract.h.html#Kernel_Function_Objects" name="Kernel Function Objects"/>
          <term file="dlib/svm/kernel_abstract.h.html" name="kernel_derivative"/>
 
+         <term file="containers.html" name="unordered_pair"/>
          <term file="containers.html" name="std_vector_c"/>
          <term file="containers.html" name="graph"/>
          <term file="containers.html" name="directed_graph"/>