Added comments to clarify when exceptions are thrown since I just changed

the definition of a missing throws block in the library introduction.

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

dlib/array/array_kernel_abstract.h

@@ -47,6 +47,9 @@ namespace dlib
                 associated with an integer value.   
                 The items are numbered from 0 though size() - 1 and
                 the operator[] functions run in constant time    
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
         
         public:

dlib/array2d/array2d_kernel_abstract.h

@@ -46,6 +46,9 @@ namespace dlib
             WHAT THIS OBJECT REPRESENTS
                 This object represents a 2-Dimensional array of objects of 
                 type T. 
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
 
 

dlib/binary_search_tree/binary_search_tree_kernel_abstract.h

@@ -63,6 +63,9 @@ namespace dlib
                 this object represents a data dictionary that is built on top of some 
                 kind of binary search tree.  It maps objects of type domain to objects
                 of type range.  
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
                     
                 NOTE:
                     definition of equivalent:

dlib/directed_graph/directed_graph_kernel_abstract.h

@@ -46,6 +46,9 @@ namespace dlib
 
                 In this object if there is a directed edge from a node A to a node B then I say 
                 that A is the parent of B and B is the child of A.
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
 
     public:

dlib/graph/graph_kernel_abstract.h

@@ -43,6 +43,9 @@ namespace dlib
             WHAT THIS OBJECT REPRESENTS
                 This object represents an undirected graph which is a set of nodes with undirected
                 edges connecting various nodes.  
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
 
     public:

dlib/hash_map/hash_map_kernel_abstract.h

@@ -68,6 +68,9 @@ namespace dlib
                 This object is similar an array.  It maps items of type domain on to 
                 items of type range.  
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
                 definition of equivalent:
                 a is equivalent to b if
                 a < b == false and

dlib/hash_set/hash_set_kernel_abstract.h

@@ -62,6 +62,9 @@ namespace dlib
                 This object represents an unaddressed collection 
                 of items.  Every element in a hash_set is unique.
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
                 definition of equivalent:
                 a is equivalent to b if
                 a < b == false and

dlib/hash_table/hash_table_kernel_abstract.h

@@ -60,6 +60,9 @@ namespace dlib
                 This object represents a data dictionary that is built on top of some 
                 kind of hash table.  The number of buckets in the hash table is 
                 defined by the constructor argument and is some power of 2.
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
                     
                 NOTE:
                     definition of equivalent:

dlib/map/map_kernel_abstract.h

@@ -58,6 +58,9 @@ namespace dlib
                 This object is similar an array.  It maps items of type domain on to 
                 items of type range.   
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
                 definition of equivalent:
                 a is equivalent to b if
                 a < b == false and

dlib/queue/queue_kernel_abstract.h

@@ -49,6 +49,9 @@ namespace dlib
                 e.g. if the queue is {b,c,d,e} and then 'a' is enqueued
                 the queue becomes {a,b,c,d,e} and then calling dequeue takes e out
                 making the queue {a,b,c,d}
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
         
         public:

dlib/reference_counter/reference_counter_kernel_abstract.h

@@ -40,6 +40,9 @@ namespace dlib
                 This object represents a container for an object of type T and 
                 provides reference counting capabilities for the object it contains   
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
         !*/
 
         public:

dlib/sequence/sequence_kernel_abstract.h

@@ -47,6 +47,9 @@ namespace dlib
                 This object represents an ordered sequence of items, each item is 
                 associated with an integer value.   
                 The items are numbered from 0 to size()-1
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
         
         public:

dlib/set/set_compare_abstract.h

@@ -35,6 +35,9 @@ namespace dlib
 
                 Also note that it is the case that for any two sets a and b 
                 if (a<b) == false and (b<a) == false then a == b. 
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
                
 
             NOTATION

dlib/sliding_buffer/sliding_buffer_kernel_abstract.h

@@ -42,6 +42,9 @@ namespace dlib
                 if instead of calling rotate_left we call rotate_right(3) instead we would have
                 "ta!some da"
                  9876543210                              
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
 
     public:

dlib/sockets/sockets_kernel_abstract.h

@@ -23,6 +23,9 @@ namespace dlib
             GENERAL WARNING
                 Don't call any of these functions or make any of these objects 
                 before main() has been entered.  
+
+        EXCEPTIONS
+            Unless specified otherwise, nothing in this file throws exceptions.
     !*/
 
 // ----------------------------------------------------------------------------------------

dlib/stack/stack_kernel_abstract.h

@@ -49,6 +49,9 @@ namespace dlib
                 e.g. if the stack is {b,c,d,e} then a is put in
                 the stack becomes {a,b,c,d,e} and then pop takes a back out
                 returning the stack to {b,c,d,e}
+
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
         !*/
         
         public:

dlib/static_map/static_map_kernel_abstract.h

@@ -48,6 +48,9 @@ namespace dlib
                 This object is similar an array.  It maps items of type domain on to 
                 items of type range.  
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
             NOTE
                 definition of equivalent:
                 a is equivalent to b if

dlib/static_set/static_set_kernel_abstract.h

@@ -41,6 +41,9 @@ namespace dlib
 
                 This object represents an unaddressed collection of items. 
 
+                Also note that unless specified otherwise, no member functions
+                of this object throw exceptions.
+
             NOTE
                 definition of equivalent:
                 a is equivalent to b if

dlib/threads/threads_kernel_abstract.h

@@ -24,6 +24,9 @@ namespace dlib
 
             If you want to change the timeout to a different value you can #define 
             DLIB_THREAD_POOL_TIMEOUT to whatever value (in milliseconds) that you like.
+
+        EXCEPTIONS
+            Unless specified otherwise, nothing in this file throws exceptions.
     !*/
 
 // ----------------------------------------------------------------------------------------

dlib/tuple/tuple_abstract.h

@@ -85,7 +85,7 @@ namespace dlib
         !*/
 
     public:
-        // the maximum number of items this tuple tepmlate can contain
+        // the maximum number of items this tuple template can contain
         const static long max_fields = 32;
 
         template <long index>