X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d644ee7ee9c5b9209ed31bb4a2250ccbc70a6402..5e1fd3eb6103c8f91bcec37ddffe322b8ddbfaa5:/docs/latex/wx/hashmap.tex

diff --git a/docs/latex/wx/hashmap.tex b/docs/latex/wx/hashmap.tex
index 128035adb1..ebb9c60e6a 100644
--- a/docs/latex/wx/hashmap.tex
+++ b/docs/latex/wx/hashmap.tex
@@ -3,7 +3,7 @@
 This is a simple, type-safe, and reasonably efficient hash map class,
 whose interface is a subset of the interface of STL containers. In
 particular, the interface is modeled after std::map, and the various,
-non standard, std::hash\_map.
+non-standard, std::hash\_map.
 
 \wxheading{Example}
 
@@ -135,6 +135,8 @@ map; it is similar to a {\tt value\_type*}}
 \twocolitem{wxHashMap::const\_iterator}{Used to enumerate all the elements
 in a constant hash map; it is similar to a {\tt const value\_type*}}
 \twocolitem{wxHashMap::size\_type}{Used for sizes}
+\twocolitem{wxHashMap::Insert\_Result}{The return value for
+\helpref{insert()}{wxhashmapinsert}}
 \end{twocollist}
 
 \wxheading{Iterators}
@@ -226,9 +228,12 @@ is returned (i.e. hashmap.find( non\_existent\_key ) == hashmap.end()).
 
 \membersection{wxHashMap::insert}\label{wxhashmapinsert}
 
-\func{void}{insert}{\param{const value\_type\&}{ v}}
+\func{Insert\_Result}{insert}{\param{const value\_type\&}{ v}}
 
-Inserts the given value in the hash map.
+Inserts the given value in the hash map. The return value is
+equivalent to a \texttt{std::pair<wxHashMap::iterator, bool>};
+the iterator points to the inserted element, the boolean value
+is \texttt{true} if \texttt{v} was actually inserted.
 
 \membersection{wxHashMap::operator[]}\label{wxhashmapbracket}